com.ca.commons.datamodel
Interface DataModelEnumDef

All Known Implementing Classes:

DataModelEnumDef.Simple

public interface DataModelEnumDef

A definition of an enumeration type. This comprises of a set of DataModelEnumValue objects that define the complete set of valid values for this enumeration.

Nested Class Summary

static class

DataModelEnumDef.Simple

Method Summary

String	getName()
DataModelEnumValue	getValueByName(String name) Look-up based on symbolic enum value.
DataModelEnumValue	getValueByOrdinal(int i) Look-up based on enum ordinal value.
Collection<? extends DataModelEnumValue>	getValues()
Collection<String>	getValuesStrings()
boolean	isValueName(String name) Return true if provided name is one of contained symbolic enum values.

Method Detail

getName

@NotNull
String getName()

getValues

@NotNull
Collection<? extends DataModelEnumValue> getValues()

getValuesStrings

@NotNull
Collection<String> getValuesStrings()

Returns:

Array of legal enum values.

getValueByName

@NotNull
DataModelEnumValue getValueByName(String name)

Look-up based on symbolic enum value.

getValueByOrdinal

@NotNull
DataModelEnumValue getValueByOrdinal(int i)

Look-up based on enum ordinal value.

isValueName

boolean isValueName(String name)

Return true if provided name is one of contained symbolic enum values.