com.anaptecs.jeaf.junit.openapi.base

Class Entity

java.lang.Object

com.anaptecs.jeaf.junit.openapi.base.Entity

public final class Entity
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entity.EntityType

Field Summary

Fields

Modifier and Type	Field and Description
static Entity	DISCOUNT_CAMPAIGN
static Entity	DISCOUNT_OFFER

Constructor Summary

Constructors

Constructor and Description
Entity(Entity.EntityType pLiteral) Initialize object from real enumeration literal
Entity(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)
Entity.EntityType	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 Entity	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

DISCOUNT_CAMPAIGN

public static final Entity DISCOUNT_CAMPAIGN

DISCOUNT_OFFER

public static final Entity DISCOUNT_OFFER

Constructor Detail

Entity

public Entity(Entity.EntityType 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.

Entity

public Entity(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 Entity 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 Entity.EntityType getLiteral()

Method returns the literal that is represented by this object.

Returns:

Entity 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