ch.systemsx.cisd.hdf5

Class HDF5EnumerationValue

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5EnumerationValue

public final class HDF5EnumerationValue
extends java.lang.Object

A class the represents an HDF enumeration value.

Constructor Summary

Constructors

Constructor and Description
HDF5EnumerationValue(HDF5EnumerationType type, java.lang.Enum<?> value) Creates an enumeration value.
HDF5EnumerationValue(HDF5EnumerationType type, int ordinal) Creates an enumeration value.
HDF5EnumerationValue(HDF5EnumerationType type, java.lang.String value) Creates an enumeration value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() Returns a description of this value.
int	getOrdinal() Returns the ordinal value.
HDF5EnumerationType	getType() Returns the type of this enumeration value.
java.lang.String	getValue() Returns the string value.
<T extends java.lang.Enum<T>> T	getValue(java.lang.Class<T> enumClass) Returns the value as Enum of type enumClass.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HDF5EnumerationValue

public HDF5EnumerationValue(HDF5EnumerationType type,
                            java.lang.Enum<?> value)
                     throws java.lang.IllegalArgumentException

Creates an enumeration value.

Parameters:

type - The enumeration type of this value.

value - The value in the type.

Throws:

java.lang.IllegalArgumentException - If the ordinal is outside of the range of allowed values of the type.

HDF5EnumerationValue

public HDF5EnumerationValue(HDF5EnumerationType type,
                            int ordinal)
                     throws java.lang.IllegalArgumentException

Creates an enumeration value.

Parameters:

type - The enumeration type of this value.

ordinal - The ordinal value of the value in the type.

Throws:

java.lang.IllegalArgumentException - If the ordinal is outside of the range of allowed values of the type.

HDF5EnumerationValue

public HDF5EnumerationValue(HDF5EnumerationType type,
                            java.lang.String value)
                     throws java.lang.IllegalArgumentException

Creates an enumeration value.

Parameters:

type - The enumeration type of this value.

value - The string value (needs to be one of the values of type).

Throws:

java.lang.IllegalArgumentException - If the value is not one of the values of type.

Method Detail

getType

public HDF5EnumerationType getType()

Returns the type of this enumeration value.

getValue

public java.lang.String getValue()

Returns the string value.

getOrdinal

public int getOrdinal()

Returns the ordinal value.

getValue

public <T extends java.lang.Enum<T>> T getValue(java.lang.Class<T> enumClass)

Returns the value as Enum of type enumClass.

getDescription

public java.lang.String getDescription()

Returns a description of this value.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object