Package org.apache.rat.configuration

Class XMLConfigurationReader

java.lang.Object
org.apache.rat.configuration.XMLConfigurationReader
All Implemented Interfaces:
LicenseReader, MatcherReader
public final class XMLConfigurationReader extends Object implements LicenseReader, MatcherReader
A class that reads the XML configuration file format.

  • Constructor Details

    • XMLConfigurationReader

      public XMLConfigurationReader()
      Constructs the XML configuration reader.

  • Method Details

    • addLicenses

      public void addLicenses​(URI uri)
      Description copied from interface: LicenseReader
      Adds a URI to the set of files to be read.
      Specified by:
      addLicenses in interface LicenseReader
      Parameters:
      uri - the URI to read.

    • read

      public void read​(Reader reader)
      Read xml from a reader.
      Parameters:
      reader - the reader to read XML from.

    • read

      public void read​(URI... uris)
      Read the uris and extract the DOM information to create new objects.
      Parameters:
      uris - The URIs to read.

    • add

      public void add​(Document newDoc)
      Merge the new document into the document that this reader processes is building.
      Parameters:
      newDoc - the Document to merge.

    • readLicenses

      public SortedSet<ILicense> readLicenses()
      Description copied from interface: LicenseReader
      Reads the configuration and extracts instances of ILicense.
      Specified by:
      readLicenses in interface LicenseReader
      Returns:
      A collection of ILicense.

    • readFamilies

      public SortedSet<ILicenseFamily> readFamilies()
      Description copied from interface: LicenseReader
      Reads the configuration and extracts instances of ILicenseFamily.
      Specified by:
      readFamilies in interface LicenseReader
      Returns:
      A collection of ILicenseFamily.

    • approvedLicenseId

      public SortedSet<String> approvedLicenseId()
      Description copied from interface: LicenseReader
      Reads the configuration and extracts the list of approved licenses.
      Specified by:
      approvedLicenseId in interface LicenseReader
      Returns:
      The list of approved licenses specified in the configuration or an empty list if none specified.

    • readMatcherBuilders

      public void readMatcherBuilders()
      Description copied from interface: MatcherReader
      Reads the configuration and MatcherBuilder classes and adds them to Readers.
      Specified by:
      readMatcherBuilders in interface MatcherReader

    • addMatchers

      public void addMatchers​(URI uri)
      Description copied from interface: MatcherReader
      Adds a URI to the set of files to be read.
      Specified by:
      addMatchers in interface MatcherReader
      Parameters:
      uri - the URI to read.