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 java.util.regex.Pattern;
22  
23  import org.apache.rat.analysis.IHeaders;
24  import org.apache.rat.config.parameters.ComponentType;
25  import org.apache.rat.config.parameters.ConfigComponent;
26  
27  /**
28   * A simple regular expression matching IHeaderMatcher
29   */
30  @ConfigComponent(type = ComponentType.MATCHER, name = "regex",
31          desc = "Performs a regular expression match using the enclosed text. " +
32                  "This is a relatively slow matcher.")
33  public class SimpleRegexMatcher extends AbstractHeaderMatcher {
34      /**
35       * The regular expression pattern to match.
36       */
37      @ConfigComponent(type = ComponentType.PARAMETER, desc = "The pattern to match", name = "expression", parameterType = String.class)
38      private final Pattern pattern;
39  
40      /**
41       * Constructs a regex pattern matcher with a unique random id and the specified
42       * Regex pattern.
43       *
44       * @param id the id for this matcher, may be null.
45       * @param pattern the pattern to match.
46       */
47      public SimpleRegexMatcher(final String id, final Pattern pattern) {
48          super(id);
49          this.pattern = pattern;
50      }
51  
52      /**
53       * Gets the expression of the underlying matching pattern.
54       * @return the underlying pattern's construction expression.
55       */
56      public String getExpression() {
57          // called by reflection
58          return pattern.pattern();
59      }
60  
61      @Override
62      public boolean matches(final IHeaders headers) {
63          return pattern.matcher(headers.raw()).find();
64      }
65  }