Package org.apache.rat.api.domain

Enum RatLicenseFamily

java.lang.Object

java.lang.Enum<RatLicenseFamily>

org.apache.rat.api.domain.RatLicenseFamily

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RatLicenseFamily>

public enum RatLicenseFamily
extends java.lang.Enum<RatLicenseFamily>

Enumerates standard license families known to Rat.

Enum Constant Summary

Enum Constants

Enum Constant	Description
APACHE
CDDL1
DOJO
GPL1
GPL2
GPL3
MIT
OASIS
TMF854
W3C
W3C_DOCUMENTATION

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	category
private LicenseFamily	licenseFamily	Constructed from other data
private java.lang.String	name
private java.lang.String	notes

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RatLicenseFamily(java.lang.String name, java.lang.String category, java.lang.String notes)	Constructs an instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCategory()
java.lang.String	getName()
java.lang.String	getNotes()
LicenseFamily	licenseFamily()	Gets a LicenseFamily representing this data.
static RatLicenseFamily	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static RatLicenseFamily[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APACHE

public static final RatLicenseFamily APACHE

GPL1

public static final RatLicenseFamily GPL1

GPL2

public static final RatLicenseFamily GPL2

GPL3

public static final RatLicenseFamily GPL3

MIT

public static final RatLicenseFamily MIT

CDDL1

public static final RatLicenseFamily CDDL1

OASIS

public static final RatLicenseFamily OASIS

TMF854

public static final RatLicenseFamily TMF854

DOJO

public static final RatLicenseFamily DOJO

W3C

public static final RatLicenseFamily W3C

W3C_DOCUMENTATION

public static final RatLicenseFamily W3C_DOCUMENTATION

Field Detail

name

private final java.lang.String name

See Also:

LicenseFamily.getName()

category

private final java.lang.String category

See Also:

LicenseFamily.getCategory()

notes

private final java.lang.String notes

See Also:

LicenseFamily.getNotes()

licenseFamily

private final LicenseFamily licenseFamily

Constructed from other data

Constructor Detail

RatLicenseFamily

private RatLicenseFamily(java.lang.String name,
                         java.lang.String category,
                         java.lang.String notes)

Constructs an instance.

Parameters:

name - not null

category - not null

notes - not null

Method Detail

values

public static RatLicenseFamily[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RatLicenseFamily c : RatLicenseFamily.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RatLicenseFamily valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Returns:

not null

See Also:

LicenseFamily.getName()

getCategory

public java.lang.String getCategory()

Returns:

possibly null

See Also:

LicenseFamily.getCategory()

getNotes

public java.lang.String getNotes()

Returns:

possibly null

See Also:

LicenseFamily.getNotes()

licenseFamily

public LicenseFamily licenseFamily()

Gets a LicenseFamily representing this data.

Returns:

not null