Package org.apache.rat.api.domain

Enum RatLicenseFamily

java.lang.Object

java.lang.Enum<RatLicenseFamily>

org.apache.rat.api.domain.RatLicenseFamily

All Implemented Interfaces:

Serializable, Comparable<RatLicenseFamily>

public enum RatLicenseFamily
extends 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

Method Summary

Modifier and Type	Method	Description
String	getCategory()
String	getName()
String	getNotes()
LicenseFamily	licenseFamily()	Gets a LicenseFamily representing this data.
static RatLicenseFamily	valueOf(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 Details

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

Method Details

values

public static RatLicenseFamily[] values()

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

Returns:

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

valueOf

public static RatLicenseFamily valueOf(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:

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

NullPointerException - if the argument is null

getName

public String getName()

Returns:

not null

See Also:

LicenseFamily.getName()

getCategory

public String getCategory()

Returns:

possibly null

See Also:

LicenseFamily.getCategory()

getNotes

public String getNotes()

Returns:

possibly null

See Also:

LicenseFamily.getNotes()

licenseFamily

public LicenseFamily licenseFamily()

Gets a LicenseFamily representing this data.

Returns:

not null