Package org.apache.rat.configuration.builders

Class SpdxBuilder

java.lang.Object

org.apache.rat.configuration.builders.AbstractBuilder

org.apache.rat.configuration.builders.SpdxBuilder

All Implemented Interfaces:

IHeaderMatcher.Builder

public class SpdxBuilder
extends AbstractBuilder

A builder for SPDX matchers.

Constructor Summary

Constructors

Constructor	Description
SpdxBuilder()

Method Summary

Modifier and Type	Method	Description
SPDXMatcherFactory.Match	build()	Build the IHeaderMatcher.
AbstractBuilder	setId(String id)	Set the id for the matcher.
SpdxBuilder	setName(String name)	Sets the name for the SPDX matcher.
String	toString()

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

getId, hasId

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

getDescription

Constructor Details

SpdxBuilder

public SpdxBuilder()

Method Details

setName

public SpdxBuilder setName(String name)

Sets the name for the SPDX matcher. This is the same as the identifier in the SPDX license list.

Parameters:

name - The text that follows the colon ':' in the SPDX tag.

Returns:

this builder.

See Also:

SPDX license list

setId

public AbstractBuilder setId(String id)

Set the id for the matcher.

Overrides:

setId in class AbstractBuilder

Parameters:

id - the id to use.

Returns:

this builder.

build

public SPDXMatcherFactory.Match build()

Description copied from interface: IHeaderMatcher.Builder

Build the IHeaderMatcher.

Implementations of this interface should return a specific child class of IHeaderMatcher.

Returns:

a new IHeaderMatcher.

toString

public String toString()

Overrides:

toString in class AbstractBuilder