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;
20  
21  import org.apache.rat.api.Document;
22  
23  /**
24   * Matches text headers to known licenses.
25   *
26   */
27  public interface IHeaderMatcher {
28  
29  	/**
30  	 * Resets this matches.
31  	 * Subsequent calls to {@link #match} will accumulate new text.
32  	 */
33  	public void reset();
34  	
35  	/**
36  	 * Matches the text accumulated to licenses.
37       * TODO probably a poor design choice - hope to fix later
38  	 * @param subject TODO
39  	 * @param line next line of text, not null
40  	 * @return TODO
41  	 */
42  	public boolean match(Document subject, String line) throws RatHeaderAnalysisException;
43  }