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 org.apache.commons.lang3.StringUtils;
22 import org.apache.rat.ConfigurationException;
23 import org.apache.rat.analysis.matchers.FullTextMatcher;
24 import org.apache.rat.analysis.matchers.SimpleTextMatcher;
25 import org.apache.rat.config.parameters.MatcherBuilder;
26
27 /**
28 * Builds a text matcher. The specific implementation is based on the complexity of the text to match.
29 */
30 @MatcherBuilder(SimpleTextMatcher.class)
31 public class TextBuilder extends AbstractBuilder {
32 /** The absolute maximum display length. */
33 private static final int MAX_DISPLAY_LENGTH = 20;
34 /** The text to match. */
35 private String text;
36
37 /**
38 * Sets the text to match.
39 * @param text the text to match
40 * @return this builder.
41 */
42 public TextBuilder setSimpleText(final String text) {
43 this.text = text.trim();
44 if (StringUtils.isBlank(text)) {
45 throw new ConfigurationException("'text' may not be empty");
46 }
47 return this;
48 }
49
50 @Override
51 public SimpleTextMatcher build() {
52 if (StringUtils.isBlank(text)) {
53 throw new ConfigurationException("text value is required");
54 }
55 boolean complex = text.contains(" ") | text.contains("\\t") | text.contains("\\n") | text.contains("\\r")
56 | text.contains("\\f") | text.contains("\\v");
57
58 return complex ? new FullTextMatcher(getId(), text) : new SimpleTextMatcher(getId(), text);
59 }
60
61 @Override
62 public String toString() {
63 if (text.length() > MAX_DISPLAY_LENGTH) {
64 return "TextBuilder: " + text.substring(0, MAX_DISPLAY_LENGTH) + "...";
65 }
66 return "TextBuilder: " + text;
67 }
68 }