Package org.apache.rat.api.domain

Class LicenseFamilyBuilder

java.lang.Object

org.apache.rat.api.domain.LicenseFamilyBuilder

public final class LicenseFamilyBuilder
extends Object

Builds LicenseFamily instances.

Method Summary

Modifier and Type	Method	Description
static LicenseFamilyBuilder	aLicenseFamily()	Begins to build a license family.
LicenseFamily	build()	Builds a family.
LicenseFamilyBuilder	withCategory(String category)	Builds family with category containing this license family.
LicenseFamilyBuilder	withName(String name)	Uniquely identifies this family.
LicenseFamilyBuilder	withNotes(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

Method Details

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(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(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(String name)

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

Parameters:

name - not null

Returns:

this instance, not null