Package org.apache.rat.configuration

Class XMLConfigurationReader

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

<rat-config>
<licenses>
<license id=id name=name >
<notes></notes>
<text> </text>
<copyright start='' end='' owner=''/>
<spdx></spdx>
<and> <matcher/>...</and>
<or> <matcher/>...</or>
<matcher_ref refid='' />
<not><matcher /></not>
</license>
</licenses>
<approved>
<family refid=''>
</approved>
<matchers>
<matcher className=''/>
<matcher className=''/>
</matchers>
</rat-config>

  • Constructor Details

    • XMLConfigurationReader

      public XMLConfigurationReader()
      Constructs the XML configuration reader.

  • Method Details

    • addLicenses

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

    • read

      public void read​(URL... urls)
      Read the urls and create a single document to process.
      Parameters:
      urls - The URLs to read.

    • add

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

    • createTextMatcher

      public static IHeaderMatcher createTextMatcher​(String id, String txt)
      Create a text matcher. Will construct a FullTextMatcher or a SimpleTextMatcher depending on the complexity of the text.
      Parameters:
      id - the id for the Matcher.
      txt - the text to match
      Returns:
      the IHeaderMatcher that matches the text.

    • 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​(URL url)
      Description copied from interface: MatcherReader
      Adds a URL to the set of files to be read.
      Specified by:
      addMatchers in interface MatcherReader
      Parameters:
      url - the URL to read.