Package org.apache.rat.api.domain

Class LicenseFamily

java.lang.Object

org.apache.rat.api.domain.LicenseFamily

public final class LicenseFamily
extends Object

Licenses are grouped into families. Each family has similar legal semantics, though some small details may differ.

For example, the 3 clause BSD license is in a family where members differ by <OWNER>, <ORGANIZATION> and <YEAR> parameters.

Constructor Summary

Constructors

Constructor	Description
LicenseFamily(String name, String category, String notes)	Constructs an immutable license family.

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Gets the name of the category containing this license family.
String	getName()	Gets the name uniquely identifying this family.
String	getNotes()	Gets 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

Constructor Details

LicenseFamily

public LicenseFamily(String name,
 String category,
 String notes)

Constructs an immutable license family.

Parameters:

name - the name uniquely identifying this family. Recommended that this be an URI. Not null.

category - the name of the category containing this license family. Recommended that this be an URI. Possibly null.

notes - further information associated with the license family. Human readable. Possibly null.

Method Details

getNotes

public String getNotes()

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

Returns:

possibly null

getCategory

public String getCategory()

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

Returns:

possibly null

getName

public String getName()

Gets the name uniquely identifying this family. Recommended that this be an URI.

Returns:

not null