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
26 /**
27 * A builder for the regex matcher.
28 */
29 public class RegexBuilder extends AbstractBuilder {
30
31 private Pattern pattern;
32
33 /**
34 * Sets the regex expression. This method compiles the string into a pattern and
35 * may throw any exception thrown by the {@code Pattern.compile(String)} method.
36 * @param exp the expression as a string.
37 * @return this builder for chaining.
38 * @see Pattern#compile(String)
39 */
40 public RegexBuilder setExpr(String exp) {
41 this.pattern = exp == null ? null : Pattern.compile(exp);
42 return this;
43 }
44
45 @Override
46 public SimpleRegexMatcher build() {
47 if (null == pattern) {
48 throw new ConfigurationException("'regex' type matcher requires an expression");
49 }
50 return new SimpleRegexMatcher(getId(), pattern);
51 }
52
53 @Override
54 public String toString() {
55 return String.format("RegexBuilder: %s", pattern == null ? null : pattern.pattern());
56 }
57
58 }