Package org.apache.rat.api.domain
Class LicenseFamily
- java.lang.Object
-
- org.apache.rat.api.domain.LicenseFamily
-
public final class LicenseFamily extends java.lang.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(java.lang.String name, java.lang.String category, java.lang.String notes)
Constructs an immutable license family.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCategory()
Gets the name of the category containing this license family.java.lang.String
getName()
Gets the name uniquely identifying this family.java.lang.String
getNotes()
Gets further information associated with the license family.
-
-
-
Field Detail
-
notes
private final java.lang.String notes
Further information associated with the license family. Human readable. Possibly null.
-
category
private final java.lang.String category
Names of the category containing this license family. Choosing a suitable URI is recommended. Possibly null;
-
name
private final java.lang.String name
Uniquely identifies this family. Choosing a suitable URI is recommended. Not null.
-
-
Constructor Detail
-
LicenseFamily
public LicenseFamily(java.lang.String name, java.lang.String category, java.lang.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 Detail
-
getNotes
public java.lang.String getNotes()
Gets further information associated with the license family. Human readable.- Returns:
- possibly null
-
getCategory
public java.lang.String getCategory()
Gets the name of the category containing this license family. Recommended that this be an URI.- Returns:
- possibly null
-
getName
public java.lang.String getName()
Gets the name uniquely identifying this family. Recommended that this be an URI.- Returns:
- not null
-
-