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.policy;
20
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.SortedSet;
24 import java.util.TreeSet;
25
26 import org.apache.rat.api.Document;
27 import org.apache.rat.document.IDocumentAnalyser;
28 import org.apache.rat.license.ILicenseFamily;
29
30 /**
31 * A default Document Analyser that determines if the matched license is in the
32 * set of approved licenses.
33 */
34 public class DefaultPolicy implements IDocumentAnalyser {
35 /** The set of all approved license families */
36 private final SortedSet<ILicenseFamily> approvedLicenseFamilies;
37
38 /**
39 * Constructor with the list of approved license families.
40 * @param approvedLicenseFamilies the approved license families.
41 */
42 public DefaultPolicy(final Collection<ILicenseFamily> approvedLicenseFamilies) {
43 this.approvedLicenseFamilies = new TreeSet<>();
44 this.approvedLicenseFamilies.addAll(approvedLicenseFamilies);
45 }
46
47 /**
48 * Adds an ILicenseFamily to the list of approved licenses.
49 * @param approvedLicense license to be approved.
50 */
51 public void add(final ILicenseFamily approvedLicense) {
52 this.approvedLicenseFamilies.add(approvedLicense);
53 }
54
55 @Override
56 public void analyse(final Document document) {
57 if (document != null) {
58 document.getMetaData().setApprovedLicenses(getApprovedLicenseFamilies());
59 }
60 }
61
62 /**
63 * Gets an unmodifiable reference to the SortedSet of approved licenses that
64 * this policy is holding.
65 * @return sorted set of license family definitions.
66 */
67 public SortedSet<ILicenseFamily> getApprovedLicenseFamilies() {
68 return Collections.unmodifiableSortedSet(approvedLicenseFamilies);
69 }
70 }