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", desc = "Performs a regex match using the enclosed the text") 31 public class SimpleRegexMatcher extends AbstractHeaderMatcher { 32 33 @ConfigComponent(type = ComponentType.PARAMETER, desc = "The pattern to match", name="expr", parameterType = String.class) 34 private final Pattern pattern; 35 36 /** 37 * Constructs a regex pattern matcher with a unique random id and the specified 38 * Regex pattern. 39 * 40 * @param id the id for this matcher, may be null 41 * @param pattern the pattern to match. Pattern will only match a single line 42 * from the input stream. 43 */ 44 public SimpleRegexMatcher(String id, Pattern pattern) { 45 super(id); 46 this.pattern = pattern; 47 } 48 49 public String getPattern() { 50 return pattern.pattern(); 51 } 52 53 @Override 54 public boolean matches(IHeaders headers) { 55 return pattern.matcher(headers.raw()).find(); 56 } 57 }