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 Summary

Constructors

Constructor and Description
XMLConfigurationReader() Constructs the XML configuration reader.

Method Summary

Modifier and Type	Method and Description
void	add(Document newDoc) Merge the new document into the document that this reader processes.
void	addLicenses(URL url) Adds a URL to the set of files to be read.
void	addMatchers(URL url) Adds a URL to the set of files to be read.
SortedSet<String>	approvedLicenseId() Reads the configuration and extracts the list of approved licenses.
Log	getLog() Returns the log the reader.
void	read(Reader reader) Read xml from a reader.
void	read(URL... urls) Read the urls and extract the DOM information to create new objects.
SortedSet<ILicenseFamily>	readFamilies() Reads the configuration and extracts instances of ILicenseFamily.
SortedSet<ILicense>	readLicenses() Reads the configuration and extracts instances of ILicense.
void	readMatcherBuilders() Reads the configuration and MatcherBuilder classes and adds them to Readers.
void	setLog(Log log) Sets the logger to use during parsing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLConfigurationReader

public XMLConfigurationReader()

Constructs the XML configuration reader.

Method Detail

setLog

public void setLog(Log log)

Description copied from interface: LicenseReader

Sets the logger to use during parsing.

Specified by:

setLog in interface LicenseReader

Parameters:

log - the log to use.

getLog

public Log getLog()

Returns the log the reader.

Returns:

the log if set, if not set DefaultLog.getInstance() is returned.

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(Reader reader)

Read xml from a reader.

Parameters:

reader - the reader to read XML from.

read

public void read(URL... urls)

Read the urls and extract the DOM information to create new objects.

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.

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.