View Javadoc
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.analysis.matchers;
20  
21  import org.apache.commons.lang3.StringUtils;
22  import org.apache.rat.analysis.IHeaders;
23  import org.apache.rat.config.parameters.ComponentType;
24  import org.apache.rat.config.parameters.ConfigComponent;
25  
26  /**
27   * A simple text matching IHeaderMatcher implementation.
28   */
29  @ConfigComponent(type = ComponentType.MATCHER, name = "text", desc = "Matches the enclosed text")
30  public class SimpleTextMatcher extends AbstractHeaderMatcher {
31      /**
32       * The text to match.
33       */
34      @ConfigComponent(type = ComponentType.PARAMETER, name = "simpleText", desc = "The text to match", required = true)
35      private final String simpleText;
36  
37      /**
38       * Constructs the simple text matcher for the simple string.
39       *
40       * @param simpleText The pattern to match. Will only match a single line from
41       * the input stream.
42       */
43      public SimpleTextMatcher(final String simpleText) {
44          this(null, simpleText);
45      }
46  
47      @Override
48      protected final void finalize() throws Throwable { // NOSONAR
49          // no sonar because this is how we ensure that the finalize bug does not bite us
50          super.finalize(); // NOSONAR
51        // finalizer attack remediation.
52      }
53  
54      /**
55       * Constructs the simple text matcher for the simple string.
56       *
57       * @param id The id for this matcher.
58       * @param simpleText The pattern to match.
59       */
60      public SimpleTextMatcher(final String id, final String simpleText) {
61          super(id);
62          if (StringUtils.isBlank(simpleText)) {
63              throw new IllegalArgumentException("Simple text may not be null, empty or blank");
64          }
65          this.simpleText = simpleText;
66      }
67  
68      public String getSimpleText() {
69          return this.simpleText;
70      }
71  
72      @Override
73      public boolean matches(final IHeaders headers) {
74          return headers.raw().contains(simpleText);
75      }
76  }