ch.systemsx.cisd.hdf5

Class HDF5EnumerationValueArray

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5EnumerationValueArray

All Implemented Interfaces:

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

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

A class the represents an array of HDF enumeration values.

Constructor Summary

Constructors

Constructor and Description
HDF5EnumerationValueArray(HDF5EnumerationType type, byte[] ordinalArray) Creates an enumeration value array.
HDF5EnumerationValueArray(HDF5EnumerationType type, java.lang.Enum<?>[] valueArray) Creates an enumeration value array.
HDF5EnumerationValueArray(HDF5EnumerationType type, int[] ordinalArray) Creates an enumeration value array.
HDF5EnumerationValueArray(HDF5EnumerationType type, short[] ordinalArray) Creates an enumeration value array.
HDF5EnumerationValueArray(HDF5EnumerationType type, java.lang.String[] valueArray) Creates an enumeration value array.

Method Summary

Modifier and Type	Method and Description
int	getLength() Returns the number of members of this enumeration array.
int	getOrdinal(int arrayIndex) Returns the ordinal value for the arrayIndex.
HDF5EnumerationType	getType() Returns the type of this enumeration array.
<T extends java.lang.Enum<T>> T	getValue(java.lang.Class<T> enumClass, int arrayIndex) Returns the value as Enum of type enumClass.
java.lang.String	getValue(int arrayIndex) Returns the string value for arrayIndex.
java.util.Iterator<java.lang.String>	iterator()
<T extends java.lang.Enum<T>> T[]	toEnumArray(java.lang.Class<T> enumClass) Returns the values for all elements of this array as Enums of type enumClass.
java.lang.String	toString()
java.lang.String[]	toStringArray() Returns the string values for all elements of this array.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HDF5EnumerationValueArray

public HDF5EnumerationValueArray(HDF5EnumerationType type,
                                 byte[] ordinalArray)
                          throws java.lang.IllegalArgumentException

Creates an enumeration value array.

Parameters:

type - The enumeration type of this value.

ordinalArray - The array of ordinal values in the type.

Throws:

java.lang.IllegalArgumentException - If any of the ordinals in the ordinalArray is outside of the range of allowed values of the type.

HDF5EnumerationValueArray

public HDF5EnumerationValueArray(HDF5EnumerationType type,
                                 short[] ordinalArray)
                          throws java.lang.IllegalArgumentException

Creates an enumeration value array.

Parameters:

type - The enumeration type of this value.

ordinalArray - The array of ordinal values in the type.

Throws:

java.lang.IllegalArgumentException - If any of the ordinals in the ordinalArray is outside of the range of allowed values of the type.

HDF5EnumerationValueArray

public HDF5EnumerationValueArray(HDF5EnumerationType type,
                                 int[] ordinalArray)
                          throws java.lang.IllegalArgumentException

Creates an enumeration value array.

Parameters:

type - The enumeration type of this value.

ordinalArray - The array of ordinal values in the type.

Throws:

java.lang.IllegalArgumentException - If any of the ordinals in the ordinalArray is outside of the range of allowed values of the type.

HDF5EnumerationValueArray

public HDF5EnumerationValueArray(HDF5EnumerationType type,
                                 java.lang.Enum<?>[] valueArray)
                          throws java.lang.IllegalArgumentException

Creates an enumeration value array.

Parameters:

type - The enumeration type of this value.

valueArray - The array of enum values (each one needs to be one of the values of type).

Throws:

java.lang.IllegalArgumentException - If any of the values in the valueArray is not one of the values of type.

HDF5EnumerationValueArray

public HDF5EnumerationValueArray(HDF5EnumerationType type,
                                 java.lang.String[] valueArray)
                          throws java.lang.IllegalArgumentException

Creates an enumeration value array.

Parameters:

type - The enumeration type of this value.

valueArray - The array of string values (each one needs to be one of the values of type).

Throws:

java.lang.IllegalArgumentException - If any of the values in the valueArray is not one of the values of type.

Method Detail

getType

public HDF5EnumerationType getType()

Returns the type of this enumeration array.

getLength

public int getLength()

Returns the number of members of this enumeration array.

getOrdinal

public int getOrdinal(int arrayIndex)

Returns the ordinal value for the arrayIndex.

Parameters:

arrayIndex - The index in the array to get the ordinal for.

getValue

public java.lang.String getValue(int arrayIndex)

Returns the string value for arrayIndex.

Parameters:

arrayIndex - The index in the array to get the value for.

getValue

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

Returns the value as Enum of type enumClass.

Parameters:

enumClass - The class to return the value as.

arrayIndex - The index in the array to get the value for.

toStringArray

public java.lang.String[] toStringArray()

Returns the string values for all elements of this array.

toEnumArray

public <T extends java.lang.Enum<T>> T[] toEnumArray(java.lang.Class<T> enumClass)

Returns the values for all elements of this array as Enums of type enumClass.

iterator

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

Specified by:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object