ch.systemsx.cisd.hdf5

Class HDF5EnumerationType

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5DataType

ch.systemsx.cisd.hdf5.HDF5EnumerationType

All Implemented Interfaces:

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

public final class HDF5EnumerationType
extends HDF5DataType
implements java.lang.Iterable<java.lang.String>

A class that represents an enumeration for a given HDF5 file and values array.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HDF5EnumerationType.EnumStorageForm The storage form (as size in bytes) of an enumeration type.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
EnumerationType	getEnumerationType() Returns the (file-independent) EnumerationType of this (file-dependen) HDF5EnumerationType.
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 and null otherwise.

Methods inherited from class ch.systemsx.cisd.hdf5.HDF5DataType

getDataTypeInformation, getDataTypeInformation, getName, tryGetDataTypePath

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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.

tryGetName

public java.lang.String tryGetName()

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

Specified by:

tryGetName in class HDF5DataType

getValues

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

Returns the allowed values of this enumeration type.

getEnumerationType

public EnumerationType getEnumerationType()

Returns the (file-independent) EnumerationType of this (file-dependen) HDF5EnumerationType.

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 HDF5DataType

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class HDF5DataType