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.mp;
20  
21  import java.util.SortedSet;
22  
23  import org.apache.maven.plugins.annotations.Parameter;
24  import org.apache.rat.analysis.IHeaderMatcher;
25  import org.apache.rat.license.ILicense;
26  import org.apache.rat.license.ILicenseFamily;
27  
28  /**
29   *  @deprecated use Configuration file to define licenses
30   */
31  @Deprecated
32  public class License extends EnclosingMatcher {
33  
34      private final ILicense.Builder builder = ILicense.builder();
35  
36      @Parameter(required = false)
37      private String notes;
38  
39      @Parameter(required = true)
40      private String id;
41      
42      @Parameter(required = true)
43      private String family;
44  
45      @Parameter(required = true)
46      private String name;
47  
48      public License() {
49      }
50  
51      @Override
52      protected void setMatcher(IHeaderMatcher.Builder builder) {
53          this.builder.setMatcher(builder);
54      }
55  
56      public ILicense build(SortedSet<ILicenseFamily> context) {
57          
58          return builder.setLicenseFamilies(context)
59                  .setFamily(family).setId(id)
60                  .setName(name).setNote(notes).build();
61      }
62  
63      @Override
64      public String toString() {
65          return '{' + family + ':' + id + ':' + name + '}';
66      }
67  
68  }