Package org.apache.rat.license

Enum LicenseSetFactory.LicenseFilter

java.lang.Object

java.lang.Enum<LicenseSetFactory.LicenseFilter>

org.apache.rat.license.LicenseSetFactory.LicenseFilter

All Implemented Interfaces:

Serializable, Comparable<LicenseSetFactory.LicenseFilter>

Enclosing class:

LicenseSetFactory

public static enum LicenseSetFactory.LicenseFilter
extends Enum<LicenseSetFactory.LicenseFilter>

An enum that defines the types of Licenses to extract.

Enum Constant Summary

Enum Constants

Enum Constant	Description
all	All defined licenses are returned
approved	Only approved licenses are returned
none	No licenses are returned

Method Summary

Modifier and Type	Method	Description
static LicenseSetFactory.LicenseFilter	fromText(String s)	Converts from a String to an enum value.
static LicenseSetFactory.LicenseFilter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LicenseSetFactory.LicenseFilter[]	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

all

public static final LicenseSetFactory.LicenseFilter all

All defined licenses are returned

approved

public static final LicenseSetFactory.LicenseFilter approved

Only approved licenses are returned

none

public static final LicenseSetFactory.LicenseFilter none

No licenses are returned

Method Details

values

public static LicenseSetFactory.LicenseFilter[] 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 LicenseSetFactory.LicenseFilter 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

fromText

public static LicenseSetFactory.LicenseFilter fromText(String s)

Converts from a String to an enum value.

Parameters:

s - String representation.

Returns:

given licenseFilter for the given String representation.