Package org.apache.rat.configuration

Interface LicenseReader

All Known Implementing Classes:
XMLConfigurationReader
public interface LicenseReader
An interface describing the methods of a LicenseReader.

  • Method Details

    • addLicenses

      void addLicenses​(URL url)
      Adds a URL to the set of files to be read.
      Parameters:
      url - the URL to read.

    • readLicenses

      SortedSet<ILicense> readLicenses()
      Reads the configuration and extracts instances of ILicense.
      Returns:
      A collection of ILicense.

    • readFamilies

      SortedSet<ILicenseFamily> readFamilies()
      Reads the configuration and extracts instances of ILicenseFamily.
      Returns:
      A collection of ILicenseFamily.

    • approvedLicenseId

      SortedSet<String> approvedLicenseId()
      Reads the configuration and extracts the list of approved licenses.
      Returns:
      The list of approved licenses specified in the configuration or an empty list if none specified.