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.configuration;
20
21 import java.net.URL;
22 import java.util.SortedSet;
23
24 import org.apache.rat.license.ILicense;
25 import org.apache.rat.license.ILicenseFamily;
26
27 /**
28 * An interface describing the methods of a LicenseReader.
29 */
30 public interface LicenseReader {
31 /**
32 * Adds a URL to the set of files to be read.
33 *
34 * @param url the URL to read.
35 */
36 void addLicenses(URL url);
37
38 /**
39 * Reads the configuration and extracts instances of ILicense.
40 *
41 * @return A collection of ILicense.
42 */
43 SortedSet<ILicense> readLicenses();
44
45 /**
46 * Reads the configuration and extracts instances of ILicenseFamily.
47 *
48 * @return A collection of ILicenseFamily.
49 */
50 SortedSet<ILicenseFamily> readFamilies();
51
52 /**
53 * Reads the configuration and extracts the list of approved licenses.
54 *
55 * @return The list of approved licenses specified in the configuration or an
56 * empty list if none specified.
57 */
58 SortedSet<String> approvedLicenseId();
59 }