com.anaptecs.jeaf.junit.openapi.base

Class ExtensibleEnum

java.lang.Object

com.anaptecs.jeaf.junit.openapi.base.ExtensibleEnum

public final class ExtensibleEnum
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtensibleEnum.ExtensibleEnumType

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensibleEnum	BLUE
static ExtensibleEnum	GREEN
static ExtensibleEnum	RED

Constructor Summary

Constructors

Constructor and Description
ExtensibleEnum(ExtensibleEnum.ExtensibleEnumType pLiteral) Initialize object from real enumeration literal
ExtensibleEnum(String pLiteralName) Initialize object using the name of the literal.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object pObject) Object.equals(Object)
ExtensibleEnum.ExtensibleEnumType	getLiteral() Method returns the literal that is represented by this object.
String	getUnknownLiteralName() Method returns the actual name of the unknown literal
int	hashCode() Object.hashCode()
boolean	isUnknownLiteral() Method checks if the represented literal is actually unknown or not.
String	toString() Object.toString()
static ExtensibleEnum	valueOf(String pLiteralName) Method returns extensible enumeration based on the passed name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RED

public static final ExtensibleEnum RED

GREEN

public static final ExtensibleEnum GREEN

BLUE

public static final ExtensibleEnum BLUE

Constructor Detail

ExtensibleEnum

public ExtensibleEnum(ExtensibleEnum.ExtensibleEnumType pLiteral)

Initialize object from real enumeration literal

Parameters:

pLiteral - Enumeration literal that should be used to initialize the extensible enumeration. The parameter must not be null.

ExtensibleEnum

public ExtensibleEnum(String pLiteralName)

Initialize object using the name of the literal.

Parameters:

pLiteralName - Literal name that should be used to initialize the extensible enumeration. If the parameter is null or has an unknown literal name then a "unknown" version will be created.

See Also:

isUnknownLiteral()

Method Detail

valueOf

public static ExtensibleEnum valueOf(String pLiteralName)

Method returns extensible enumeration based on the passed name. If the literal name is unknown then an instance representing "unknown" will be returned.

Parameters:

pLiteral - Enumeration literal that should be used to initialize the extensible enumeration. The parameter must not be null.

Returns:

getLiteral

public ExtensibleEnum.ExtensibleEnumType getLiteral()

Method returns the literal that is represented by this object.

Returns:

ExtensibleEnum Literal that is represented by this object. The method never returns null.

isUnknownLiteral

public boolean isUnknownLiteral()

Method checks if the represented literal is actually unknown or not.

Returns:

boolean Method returns true if this object represents an unknown literal.

getUnknownLiteralName

public String getUnknownLiteralName()

Method returns the actual name of the unknown literal

Returns:

String Name of the unknown literal or null in case that the literal is known.

hashCode

public int hashCode()

Object.hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object pObject)

Object.equals(Object)

Overrides:

equals in class Object

toString

public String toString()

Object.toString()

Overrides:

toString in class Object