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.anttasks;
20  
21  import org.apache.rat.analysis.RatHeaderAnalysisException;
22  import org.apache.rat.analysis.license.FullTextMatchingLicense;
23  import org.apache.rat.api.Document;
24  import org.apache.tools.ant.BuildException;
25  import org.apache.tools.ant.Project;
26  
27  /**
28   * Adapts {@link FullTextMatchingLicense FullTextMatchingLicense}
29   * to Ant's method naming conventions so it becomes easy to write
30   * text matching based license matchers inside an Ant build file.
31   * @since Rat Antlib 0.9
32   */
33  public class FullTextLicenseMatcher extends FullTextMatchingLicense {
34      private boolean validated = false;
35      private String fullText = "";
36      private Project project;
37  
38      public void setProject(Project project) {
39          this.project = project;
40      }
41  
42      public void addText(String text) {
43          if (text != null && text.trim().length() > 0) {
44              setFullText(fullText += project.replaceProperties(text));
45          }
46      }
47  
48      @Override
49      public boolean match(Document subject, String line) throws RatHeaderAnalysisException {
50          validate();
51          return super.match(subject, line);
52      }
53  
54      private void validate() {
55          if (!validated) {
56              validated  = true;
57              if (!hasFullText()) {
58                  throw new BuildException("You must specify the text to match.");
59              }
60              if (getLicenseFamilyCategory() == null) {
61                  throw new BuildException("The licenseFamilyCategory attribute"
62                                           + " is required.");
63              }
64              if (getLicenseFamilyName() == null) {
65                  throw new BuildException("The licenseFamilyName attribute"
66                                           + " is required.");
67              }
68          }
69      }
70  
71  }