Package com.mooltiverse.oss.nyx.data

Enum Scheme

java.lang.Object

java.lang.Enum<Scheme>

com.mooltiverse.oss.nyx.data.Scheme

All Implemented Interfaces:

Serializable, Comparable<Scheme>

public enum Scheme
extends Enum<Scheme>

This class maps version Schemes and the corresponding configuration options or state attributes, whose string representations may not always match the Scheme values. Although there is a one to one mapping with these values and those in the version Scheme the two must not be confused. This class is meant to map configuration values and state attributes (lowercase strings) to version Scheme. In other words, this is is the mapping between version schemes and the string values users can use in configuration to ask for those schemes or returned by state attributes.

See Also:

Scheme

Enum Constant Summary

Enum Constants

Enum Constant	Description
SEMVER	The Semantic Versioning scheme.

Method Summary

Modifier and Type	Method	Description
static Scheme	from(Scheme scheme)	Returns the proper scheme mapped from the given version scheme.
static Scheme	from(String value)	Returns the proper version scheme mapped from the given value.
Scheme	getScheme()	Returns the version scheme
String	getValue()	Returns the string representation of this scheme.
static Scheme	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Scheme[]	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

SEMVER

public static final Scheme SEMVER

The Semantic Versioning scheme.

See Also:

Scheme.SEMVER

Method Detail

values

public static Scheme[] 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 (Scheme c : Scheme.values())
    System.out.println(c);

Returns:

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

valueOf

public static Scheme 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

getScheme

public Scheme getScheme()

Returns the version scheme

Returns:

the version scheme

getValue

public String getValue()

Returns the string representation of this scheme. This string is also used in configuration options and state attributes.

Returns:

the string representation of this scheme

from

public static Scheme from(Scheme scheme)
                   throws IllegalArgumentException,
                          NullPointerException

Returns the proper scheme mapped from the given version scheme.

Parameters:

scheme - the version scheme to parse and return the scheme for

Returns:

the proper scheme mapped from the given version scheme.

Throws:

IllegalArgumentException - if the given value cannot be mapped to any existing scheme

NullPointerException - if the given value is null

from

public static Scheme from(String value)
                   throws IllegalArgumentException,
                          NullPointerException

Returns the proper version scheme mapped from the given value.

Parameters:

value - string value scheme to parse and return the scheme for

Returns:

the proper scheme mapped from the given value.

Throws:

IllegalArgumentException - if the given value cannot be mapped to any existing scheme

NullPointerException - if the given value is null