ch.systemsx.cisd.hdf5

Class EnumerationType

java.lang.Object

ch.systemsx.cisd.hdf5.EnumerationType

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>

public class EnumerationType
extends java.lang.Object
implements java.lang.Iterable<java.lang.String>

An enumeration type, consisting of name and the list of names of the enumeration terms.

Constructor Summary

Constructors

Constructor and Description
EnumerationType(java.lang.Class<? extends java.lang.Enum<?>> enumClass)
EnumerationType(java.lang.String nameOrNull, java.lang.Class<? extends java.lang.Enum<?>> enumClass)
EnumerationType(java.lang.String nameOrNull, java.lang.String[] values)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name of this type, if it exists, or NONAME otherwise.
HDF5EnumerationType.EnumStorageForm	getStorageForm() Returns the HDF5EnumerationType.EnumStorageForm of this enumeration type.
java.util.List<java.lang.String>	getValues() Returns the allowed values of this enumeration type.
int	hashCode()
java.util.Iterator<java.lang.String>	iterator() Returns an Iterator over all values of this enumeration type.
java.lang.Integer	tryGetIndexForValue(java.lang.String value) Returns the ordinal value for the given string value, if value is a member of the enumeration, and null otherwise.
java.lang.String	tryGetName() Returns the name of this type, if it exists, or null otherwise.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnumerationType

public EnumerationType(java.lang.String nameOrNull,
               java.lang.String[] values)

EnumerationType

public EnumerationType(java.lang.Class<? extends java.lang.Enum<?>> enumClass)

EnumerationType

public EnumerationType(java.lang.String nameOrNull,
               java.lang.Class<? extends java.lang.Enum<?>> enumClass)

Method Detail

tryGetIndexForValue

public java.lang.Integer tryGetIndexForValue(java.lang.String value)

Returns the ordinal value for the given string value, if value is a member of the enumeration, and null otherwise.

getName

public java.lang.String getName()

Returns the name of this type, if it exists, or NONAME otherwise.

tryGetName

public java.lang.String tryGetName()

Returns the name of this type, if it exists, or null otherwise.

getValues

public java.util.List<java.lang.String> getValues()

Returns the allowed values of this enumeration type.

getStorageForm

public HDF5EnumerationType.EnumStorageForm getStorageForm()

Returns the HDF5EnumerationType.EnumStorageForm of this enumeration type.

iterator

public java.util.Iterator<java.lang.String> iterator()

Returns an Iterator over all values of this enumeration type. Iterator.remove() is not allowed and will throw an UnsupportedOperationException.

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object