org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs

Class EnumElementDef

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.EnumElementDef

All Implemented Interfaces:

Serializable

public class EnumElementDef
extends TypeDefElementHeader

EnumElementDef describes a single valid value defined for an enum.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

CURRENT_TYPE_DEF_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
EnumElementDef() Default constructor sets up an empty EnumElementDef
EnumElementDef(EnumElementDef template) Copy/clone constructor sets up an EnumElementDef based on the values supplied in the template.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Verify that supplied object has the same properties.
String	getDescription() Return the description for the enum value.
String	getDescriptionGUID() Return the unique identifier (guid) of the glossary term that describes this EnumElementDef.
int	getOrdinal() Return the numeric value used for the enum value.
String	getValue() Return the symbolic name for the enum value.
int	hashCode() Integer useful for hashmaps
void	setDescription(String description) Set up the description for the enum value.
void	setDescriptionGUID(String descriptionGUID) Set up the unique identifier (guid) of the glossary term that describes this EnumElementDef.
void	setOrdinal(int ordinal) Set up the numeric value for the enum value.
void	setValue(String value) Set up the symbolic name for the enum value.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumElementDef

public EnumElementDef()

Default constructor sets up an empty EnumElementDef

EnumElementDef

public EnumElementDef(EnumElementDef template)

Copy/clone constructor sets up an EnumElementDef based on the values supplied in the template.

Parameters:

template - EnumElementDef

Method Detail

getOrdinal

public int getOrdinal()

Return the numeric value used for the enum value.

Returns:

int ordinal

setOrdinal

public void setOrdinal(int ordinal)

Set up the numeric value for the enum value.

Parameters:

ordinal - int

getValue

public String getValue()

Return the symbolic name for the enum value.

Returns:

String name

setValue

public void setValue(String value)

Set up the symbolic name for the enum value.

Parameters:

value - String name

getDescription

public String getDescription()

Return the description for the enum value.

Returns:

String description

setDescription

public void setDescription(String description)

Set up the description for the enum value.

Parameters:

description - String

getDescriptionGUID

public String getDescriptionGUID()

Return the unique identifier (guid) of the glossary term that describes this EnumElementDef.

Returns:

String guid

setDescriptionGUID

public void setDescriptionGUID(String descriptionGUID)

Set up the unique identifier (guid) of the glossary term that describes this EnumElementDef.

Parameters:

descriptionGUID - String guid

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.

equals

public boolean equals(Object o)

Verify that supplied object has the same properties.

Overrides:

equals in class Object

Parameters:

o - object to test

Returns:

result

hashCode

public int hashCode()

Integer useful for hashmaps

Overrides:

hashCode in class Object

Returns:

int hash number