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 import org.apache.rat.utils.Log;
27
28 /**
29 * An interface describing the methods of a LicenseReader.
30 */
31 public interface LicenseReader {
32 /**
33 * Adds a URL to the set of files to be read.
34 *
35 * @param url the URL to read.
36 */
37 void addLicenses(URL url);
38
39 /**
40 * Reads the configuration and extracts instances of ILicense.
41 *
42 * @return A collection of ILicense.
43 */
44 SortedSet<ILicense> readLicenses();
45
46 /**
47 * Reads the configuration and extracts instances of ILicenseFamily.
48 *
49 * @return A collection of ILicenseFamily.
50 */
51 SortedSet<ILicenseFamily> readFamilies();
52
53 /**
54 * Reads the configuration and extracts the list of approved licenses.
55 *
56 * @return The list of approved licenses specified in the configuration or an
57 * empty list if none specified.
58 */
59 SortedSet<String> approvedLicenseId();
60
61 /**
62 * Sets the logger to use during parsing.
63 * @param log the log to use.
64 */
65 void setLog(Log log);
66 }