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.generation;
20  
21  import java.util.regex.Pattern;
22  
23  import org.apache.rat.analysis.IHeaderMatcher;
24  import org.apache.rat.analysis.RatHeaderAnalysisException;
25  import org.apache.rat.api.Document;
26  import org.apache.rat.api.MetaData;
27  
28  /**
29   * JavaDocs are generated and so no license is required.
30   * It is useful to not these separately.
31   */
32  public class JavaDocLicenseNotRequired implements IHeaderMatcher {
33  
34      private static final String JAVADOC_REGEX_DEFN = ".*Generated by javadoc.*";
35      
36      private static final Pattern JAVADOC_REGEX = Pattern.compile(JAVADOC_REGEX_DEFN);
37      
38      public boolean match(Document subject, String line) throws RatHeaderAnalysisException {
39          boolean result = JAVADOC_REGEX.matcher(line).matches();
40          if (result) {
41              reportOnLicense(subject);
42          }
43          return result;
44      }
45  
46      private void reportOnLicense(Document subject) throws RatHeaderAnalysisException {
47          subject.getMetaData().set(MetaData.RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN);
48      }
49      
50      public void reset() {
51          // stateless
52      }
53  }