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 Description EnumElementDef()Default constructor sets up an empty EnumElementDefEnumElementDef(EnumElementDef template)Copy/clone constructor sets up an EnumElementDef based on the values supplied in the template.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object objectToCompare)Validate that an object is equal depending on their stored values.StringgetDescription()Return the description for the enum value.StringgetDescriptionGUID()Return the unique identifier (guid) of the glossary term that describes this EnumElementDef.intgetOrdinal()Return the numeric value used for the enum value.StringgetValue()Return the symbolic name for the enum value.inthashCode()Return a hash code based on the values of this object.voidsetDescription(String description)Set up the description for the enum value.voidsetDescriptionGUID(String descriptionGUID)Set up the unique identifier (guid) of the glossary term that describes this EnumElementDef.voidsetOrdinal(int ordinal)Set up the numeric value for the enum value.voidsetValue(String value)Set up the symbolic name for the enum value.StringtoString()Standard toString method.-
Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader
getHeaderVersion, setHeaderVersion
-
-
-
-
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.
-
equals
public boolean equals(Object objectToCompare)
Validate that an object is equal depending on their stored values.
-
-