1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19 package org.apache.rat.configuration.builders;
20
21 import java.util.regex.Pattern;
22
23 import org.apache.rat.ConfigurationException;
24 import org.apache.rat.analysis.matchers.SimpleRegexMatcher;
25 import org.apache.rat.config.parameters.MatcherBuilder;
26
27 /**
28 * A builder for the regex matcher.
29 */
30 @MatcherBuilder(SimpleRegexMatcher.class)
31 public class RegexBuilder extends AbstractBuilder {
32 /** The compiled Regex pattern */
33 private Pattern pattern;
34
35 /**
36 * Sets the regex expression. This method compiles the string into a pattern and
37 * may throw any exception thrown by the {@code Pattern.compile(String)} method.
38 * @param expression the expression as a string.
39 * @return this builder for chaining.
40 * @see Pattern#compile(String)
41 */
42 public RegexBuilder setExpression(final String expression) {
43 this.pattern = expression == null ? null : Pattern.compile(expression);
44 return this;
45 }
46
47 @Override
48 public SimpleRegexMatcher build() {
49 if (null == pattern) {
50 throw new ConfigurationException("'regex' type matcher requires an expression");
51 }
52 return new SimpleRegexMatcher(getId(), pattern);
53 }
54
55 @Override
56 public String toString() {
57 return String.format("RegexBuilder: %s", pattern == null ? null : pattern.pattern());
58 }
59
60 }