org.apache.rat.api.domain

Class LicenseFamilyBuilder

java.lang.Object

org.apache.rat.api.domain.LicenseFamilyBuilder

public final class LicenseFamilyBuilder
extends java.lang.Object

Builds LicenseFamily instances.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	category Names of the category containing this license family.
private java.lang.String	name Uniquely identifies this family.
private java.lang.String	notes Further information associated with the license family.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LicenseFamilyBuilder() Use {@link #aLicenseFamily()

Method Summary

Modifier and Type	Method and Description
static LicenseFamilyBuilder	aLicenseFamily() Begins to build a license family.
LicenseFamily	build() Builds a family.
LicenseFamilyBuilder	withCategory(java.lang.String category) Builds family with category containing this license family.
LicenseFamilyBuilder	withName(java.lang.String name) Uniquely identifies this family.
LicenseFamilyBuilder	withNotes(java.lang.String notes) Builds family with further information associated with the license family.

Methods inherited from class java.lang.Object

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

Field Detail

notes

private java.lang.String notes

Further information associated with the license family. Human readable.

category

private java.lang.String category

Names of the category containing this license family. Recommended that this be an URI.

name

private java.lang.String name

Uniquely identifies this family. Choosing a suitable URI is recommended

Constructor Detail

LicenseFamilyBuilder

private LicenseFamilyBuilder()

Use {@link #aLicenseFamily()

Method Detail

aLicenseFamily

public static LicenseFamilyBuilder aLicenseFamily()

Begins to build a license family.

Returns:

a builder for a license family, not null

build

public LicenseFamily build()

Builds a family.

Returns:

not null

withNotes

public LicenseFamilyBuilder withNotes(java.lang.String notes)

Builds family with further information associated with the license family. Human readable.

Parameters:

notes - possibly null

Returns:

this instance, not null

withCategory

public LicenseFamilyBuilder withCategory(java.lang.String category)

Builds family with category containing this license family. Choosing a suitable URI is recommended

Parameters:

category - possible null

Returns:

this instance, not null

withName

public LicenseFamilyBuilder withName(java.lang.String name)

Uniquely identifies this family. Choosing a suitable URI is recommended.

Parameters:

name - not null

Returns:

this instance, not null