org.apache.rat.configuration.builders

Class ChildContainerBuilder

java.lang.Object

org.apache.rat.configuration.builders.AbstractBuilder

org.apache.rat.configuration.builders.ChildContainerBuilder

All Implemented Interfaces:

IHeaderMatcher.Builder

Direct Known Subclasses:

AllBuilder, AnyBuilder, NotBuilder

public abstract class ChildContainerBuilder
extends AbstractBuilder

Constructs a builder that contains other builders.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<IHeaderMatcher.Builder>	children The list of builders that will build the enclosed matchers.
protected String	resource The resource the builders came from if it was read from a resource

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChildContainerBuilder() Empty default constructor.

Method Summary

Modifier and Type	Method and Description
AbstractBuilder	addEnclosed(Collection<IHeaderMatcher.Builder> children) Adds a collection of builders to the list of child builders.
AbstractBuilder	addEnclosed(IHeaderMatcher.Builder child) Adds a builder to the list of builders.
List<IHeaderMatcher>	getEnclosed()
List<IHeaderMatcher.Builder>	getEnclosedBuilders()
AbstractBuilder	setResource(String resourceName) Reads a text file.
String	toString()

Methods inherited from class org.apache.rat.configuration.builders.AbstractBuilder

getId, hasId, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.rat.analysis.IHeaderMatcher.Builder

all, any, build, builtClass, copyright, getDescription, matcherRef, not, regex, spdx, text

Field Detail

children

protected final List<IHeaderMatcher.Builder> children

The list of builders that will build the enclosed matchers.

resource

protected String resource

The resource the builders came from if it was read from a resource

Constructor Detail

ChildContainerBuilder

protected ChildContainerBuilder()

Empty default constructor.

Method Detail

setResource

public AbstractBuilder setResource(String resourceName)

Reads a text file. Each line becomes a text matcher in the resulting list.

Parameters:

resourceName - the name of the resource to read.

Returns:

a List of Matchers, one for each non-empty line in the input file.

addEnclosed

public AbstractBuilder addEnclosed(IHeaderMatcher.Builder child)

Adds a builder to the list of builders.

Parameters:

child - the child builder to add.

Returns:

this for chaining.

addEnclosed

public AbstractBuilder addEnclosed(Collection<IHeaderMatcher.Builder> children)

Adds a collection of builders to the list of child builders.

Parameters:

children - the children to add.

Returns:

this for chaining.

getEnclosedBuilders

public List<IHeaderMatcher.Builder> getEnclosedBuilders()

getEnclosed

public List<IHeaderMatcher> getEnclosed()

Returns:

the list of child builders for this builder.

toString

public String toString()

Overrides:

toString in class AbstractBuilder