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  public class License extends EnclosingMatcher {
29  
30      private final ILicense.Builder builder = ILicense.builder();
31  
32      @Parameter(required = false)
33      private String notes;
34  
35      @Parameter(required = false)
36      private String derivedFrom;
37  
38      @Parameter(required = true)
39      private String id;
40      
41      @Parameter(required = true)
42      private String family;
43  
44      @Parameter(required = true)
45      private String name;
46  
47      public License() {
48      }
49  
50      @Override
51      protected void setMatcher(IHeaderMatcher.Builder builder) {
52          this.builder.setMatcher(builder);
53      }
54  
55      public ILicense build(SortedSet<ILicenseFamily> context) {
56          return builder.setDerivedFrom(derivedFrom).setLicenseFamilyCategory(family).setId(id)
57                  .setName(name).setNotes(notes).build(context);
58      }
59  
60      @Override
61      public String toString() {
62          return '{' + family + ':' + id + ':' + name + '}';
63      }
64  
65  }