Package org.apache.rat.license

Interface ILicense

All Superinterfaces:

Comparable<ILicense>, IHeaderMatcher

All Known Implementing Classes:

UnknownLicense

public interface ILicense
extends IHeaderMatcher, Comparable<ILicense>

The definition of a License.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ILicense.Builder	A builder for ILicense instances.

Nested classes/interfaces inherited from interface org.apache.rat.analysis.IHeaderMatcher

IHeaderMatcher.State

Method Summary

Modifier and Type	Method	Description
static ILicense.Builder	builder()
String	derivedFrom()
static Comparator<ILicense>	getComparator()
ILicenseFamily	getLicenseFamily()
String	getName()	Returns the name of this license.
String	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

static ILicense.Builder builder()

Returns:

An ILicense.Builder instance.

getComparator

static Comparator<ILicense> getComparator()

Returns:

The comparator for used to sort Licenses.