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.license;
20  
21  import org.apache.rat.DeprecationReporter;
22  import org.apache.rat.configuration.builders.TextBuilder;
23  import org.apache.rat.license.ILicense;
24  
25  /**
26   * Accumulates all letters and numbers contained inside the header and
27   * compares it to the full text of a given license (after reducing it
28   * to letters and numbers as well).
29   *
30   * <p>The text comparison is case-insensitive but assumes only
31   * characters in the US-ASCII charset are being matched.</p>
32   *
33   * @deprecated Use new configuration options
34   */
35  @Deprecated // Since 0.16
36  @DeprecationReporter.Info(since = "0.16", forRemoval = true, use = "new configuration options")
37  public class FullTextMatchingLicense extends BaseLicense {
38  
39      private String text;
40  
41      /** constructor */
42      public FullTextMatchingLicense() {
43          DeprecationReporter.logDeprecated(FullTextMatchingLicense.class);
44      }
45  
46      /**
47       * Set the text to match
48       * @param text the text to match
49       */
50      public final void setFullText(String text) {
51          this.text = text;
52      }
53  
54      @Override
55      public ILicense.Builder getLicense() {
56          return ILicense.builder()
57          .setFamily(getLicenseFamilyCategory())
58          .setName(getLicenseFamilyName())
59          .setMatcher(new TextBuilder().setSimpleText(text))
60          .setNote(getNotes());
61      }
62  }