Package org.apache.rat

Class Defaults.Builder

java.lang.Object

org.apache.rat.Defaults.Builder

Enclosing class:

Defaults

public static class Defaults.Builder
extends Object

The Defaults builder.

Method Summary

Modifier and Type	Method	Description
Defaults.Builder	add(File file)	Adds a configuration file to be read.
Defaults.Builder	add(String fileName)	Adds the name of a configuration file to be read.
Defaults.Builder	add(URL url)	Adds a URL to a configuration file to be read.
Defaults	build()	Builds the defaults object.
Defaults.Builder	noDefault()	Removes the default definitions from the list of files to process.
Defaults.Builder	remove(File file)	Removes a file from the list of configuration files to process.
Defaults.Builder	remove(String fileName)	Removes a file name from the list of configuration files to process.
Defaults.Builder	remove(URL url)	Removes a file from the list of configuration files to process.

Methods inherited from class java.lang.Object

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

Method Details

add

public Defaults.Builder add(URL url)

Adds a URL to a configuration file to be read.

Parameters:

url - the URL to add

Returns:

this Builder for chaining

add

public Defaults.Builder add(String fileName)
                     throws MalformedURLException

Adds the name of a configuration file to be read.

Parameters:

fileName - the name of the file to add.

Returns:

this Builder for chaining

Throws:

MalformedURLException - in case the fileName cannot be found.

add

public Defaults.Builder add(File file)
                     throws MalformedURLException

Adds a configuration file to be read.

Parameters:

file - the File to add.

Returns:

this Builder for chaining

Throws:

MalformedURLException - in case the file cannot be found.

remove

public Defaults.Builder remove(URL url)

Removes a file from the list of configuration files to process.

Parameters:

url - the URL of the file to remove.

Returns:

this Builder for chaining

remove

public Defaults.Builder remove(String fileName)
                        throws MalformedURLException

Removes a file name from the list of configuration files to process.

Parameters:

fileName - the fileName of the file to remove.

Returns:

this Builder for chaining

Throws:

MalformedURLException - in case the fileName cannot be found.

remove

public Defaults.Builder remove(File file)
                        throws MalformedURLException

Removes a file from the list of configuration files to process.

Parameters:

file - the File of the file to remove.

Returns:

this Builder for chaining

Throws:

MalformedURLException - in case the file cannot be found.

noDefault

public Defaults.Builder noDefault()

Removes the default definitions from the list of files to process.

Returns:

this Builder for chaining

build

public Defaults build()

Builds the defaults object.

Returns:

the current defaults object.