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  public interface IHeaderMatcher {
27  
28      /**
29       * Resets this matches.
30       * Subsequent calls to {@link #match} will accumulate new text.
31       */
32      void reset();
33  
34      /**
35       * Matches the text accumulated to licenses.
36       * TODO probably a poor design choice - hope to fix later
37       * @param subject current document.
38       * @param line next line of text, not null
39       * 
40       * @return whether the current line matched in the document.
41       * 
42       * @throws RatHeaderAnalysisException in case of internal RAT errors.
43       */
44      boolean match(Document subject, String line) throws RatHeaderAnalysisException;
45  }