Package org.apache.rat.license
Interface ILicense
- All Superinterfaces:
Comparable<ILicense>
,IHeaderMatcher
- All Known Implementing Classes:
UnknownLicense
The definition of a License.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
A builder for ILicense instances.Nested classes/interfaces inherited from interface org.apache.rat.analysis.IHeaderMatcher
IHeaderMatcher.State
-
Method Summary
Modifier and TypeMethodDescriptionstatic ILicense.Builder
builder()
static Comparator<ILicense>
getName()
Returns the name of this license.getNotes()
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.apache.rat.analysis.IHeaderMatcher
currentState, finalizeState, getId, matches, reset
-
Method Details
-
getLicenseFamily
ILicenseFamily getLicenseFamily()- Returns:
- the ILicenseFamily implementation for this license.
-
getNotes
String getNotes()- Returns:
- the notes associated with this license. May be null or empty.
-
derivedFrom
String derivedFrom()- Returns:
- the id of a license that this license is derived from. May be null.
-
getName
String getName()Returns the name of this license. If no name was specified then the name of the family is returned.- Returns:
- the name of this license.
-
builder
- Returns:
- An ILicense.Builder instance.
-
getComparator
- Returns:
- The comparator for used to sort Licenses.
-