ch.systemsx.cisd.hdf5

Interface IHDF5EnumValueCreator

All Known Subinterfaces:

IHDF5EnumWriter

public interface IHDF5EnumValueCreator

Interface for creation of enumeration values.

Obtain an object implementing this interface by calling IHDF5Writer.enumeration().

Method Summary

Modifier and Type	Method and Description
<T extends java.lang.Enum<T>> HDF5EnumerationValueArray	newAnonArray(java.lang.Enum<T>[] values) Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
HDF5EnumerationValueArray	newAnonArray(java.lang.String[] options, byte[] values) Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
HDF5EnumerationValueArray	newAnonArray(java.lang.String[] options, int[] values) Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
HDF5EnumerationValueArray	newAnonArray(java.lang.String[] options, short[] values) Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
HDF5EnumerationValueArray	newAnonArray(java.lang.String[] options, java.lang.String[] values) Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
<T extends java.lang.Enum<T>> HDF5EnumerationValueMDArray	newAnonMDArray(ch.systemsx.cisd.base.mdarray.MDArray<java.lang.Enum<T>> values) Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
HDF5EnumerationValueMDArray	newAnonMDArray(java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> values) Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
HDF5EnumerationValueMDArray	newAnonMDArray(java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDByteArray values) Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
HDF5EnumerationValueMDArray	newAnonMDArray(java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDIntArray values) Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
HDF5EnumerationValueMDArray	newAnonMDArray(java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDShortArray values) Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
<T extends java.lang.Enum<T>> HDF5EnumerationValue	newAnonVal(java.lang.Enum<T> value) Creates a new enumeration value with an anonymous enumeration type.
HDF5EnumerationValue	newAnonVal(java.lang.String[] options, byte value) Creates a new enumeration value with an anonymous enumeration type.
HDF5EnumerationValue	newAnonVal(java.lang.String[] options, int value) Creates a new enumeration value with an anonymous enumeration type.
HDF5EnumerationValue	newAnonVal(java.lang.String[] options, short value) Creates a new enumeration value with an anonymous enumeration type.
HDF5EnumerationValue	newAnonVal(java.lang.String[] options, java.lang.String value) Creates a new enumeration value with an anonymous enumeration type.
<T extends java.lang.Enum<T>> HDF5EnumerationValueArray	newArray(java.lang.Enum<T>[] values) Creates a new enumeration value array (of rank 1) with an enumeration type of name value.class.getSimpleName().
<T extends java.lang.Enum<T>> HDF5EnumerationValueArray	newArray(java.lang.String typeName, java.lang.Enum<T>[] values) Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.
HDF5EnumerationValueArray	newArray(java.lang.String typeName, java.lang.String[] options, byte[] values) Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.
HDF5EnumerationValueArray	newArray(java.lang.String typeName, java.lang.String[] options, int[] values) Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.
HDF5EnumerationValueArray	newArray(java.lang.String typeName, java.lang.String[] options, short[] values) Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.
HDF5EnumerationValueArray	newArray(java.lang.String typeName, java.lang.String[] options, java.lang.String[] values) Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.
<T extends java.lang.Enum<T>> HDF5EnumerationValueMDArray	newMDArray(ch.systemsx.cisd.base.mdarray.MDArray<java.lang.Enum<T>> values) Creates a new enumeration value array (of rank N) with an enumeration type of name value.class.getSimpleName().
<T extends java.lang.Enum<T>> HDF5EnumerationValueMDArray	newMDArray(java.lang.String typeName, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.Enum<T>> values) Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.
HDF5EnumerationValueMDArray	newMDArray(java.lang.String typeName, java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> values) Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.
HDF5EnumerationValueMDArray	newMDArray(java.lang.String typeName, java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDByteArray values) Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.
HDF5EnumerationValueMDArray	newMDArray(java.lang.String typeName, java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDIntArray values) Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.
HDF5EnumerationValueMDArray	newMDArray(java.lang.String typeName, java.lang.String[] options, ch.systemsx.cisd.base.mdarray.MDShortArray values) Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.
<T extends java.lang.Enum<T>> HDF5EnumerationValue	newVal(java.lang.Enum<T> value) Creates a new enumeration value with an enumeration type of name value.getClass().getSimpleName().
<T extends java.lang.Enum<T>> HDF5EnumerationValue	newVal(java.lang.String typeName, java.lang.Enum<T> value) Creates a new enumeration value with an enumeration type of name typeName.
HDF5EnumerationValue	newVal(java.lang.String typeName, java.lang.String[] options, byte value) Creates a new enumeration value with enumeration type name typeName.
HDF5EnumerationValue	newVal(java.lang.String typeName, java.lang.String[] options, int value) Creates a new enumeration value with enumeration type name typeName.
HDF5EnumerationValue	newVal(java.lang.String typeName, java.lang.String[] options, short value) Creates a new enumeration value with enumeration type name typeName.
HDF5EnumerationValue	newVal(java.lang.String typeName, java.lang.String[] options, java.lang.String value) Creates a new enumeration value with enumeration type name typeName.

Method Detail

newVal

HDF5EnumerationValue newVal(java.lang.String typeName,
                            java.lang.String[] options,
                            java.lang.String value)

Creates a new enumeration value with enumeration type name typeName.

Shortcut for new HDF5EnumerationValue(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

value - The string representation of the created enumeration value.

Returns:

The created enumeration value.

newAnonVal

HDF5EnumerationValue newAnonVal(java.lang.String[] options,
                                java.lang.String value)

Creates a new enumeration value with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

value - The string representation of the created enumeration value.

Returns:

The created enumeration value.

newVal

HDF5EnumerationValue newVal(java.lang.String typeName,
                            java.lang.String[] options,
                            int value)

Creates a new enumeration value with enumeration type name typeName.

Shortcut for new HDF5EnumerationValue(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

value - The ordinal value of the created enumeration value.

Returns:

The created enumeration value.

newAnonVal

HDF5EnumerationValue newAnonVal(java.lang.String[] options,
                                int value)

Creates a new enumeration value with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

value - The ordinal of the created enumeration value.

Returns:

The created enumeration value.

newVal

HDF5EnumerationValue newVal(java.lang.String typeName,
                            java.lang.String[] options,
                            short value)

Creates a new enumeration value with enumeration type name typeName.

Shortcut for new HDF5EnumerationValue(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

value - The ordinal value of the created enumeration value.

Returns:

The created enumeration value.

newAnonVal

HDF5EnumerationValue newAnonVal(java.lang.String[] options,
                                short value)

Creates a new enumeration value with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

value - The ordinal value of the created enumeration value.

Returns:

The created enumeration value.

newVal

HDF5EnumerationValue newVal(java.lang.String typeName,
                            java.lang.String[] options,
                            byte value)

Creates a new enumeration value with enumeration type name typeName.

Shortcut for new HDF5EnumerationValue(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

value - The ordinal value of the created enumeration value.

Returns:

The created enumeration value.

newAnonVal

HDF5EnumerationValue newAnonVal(java.lang.String[] options,
                                byte value)

Creates a new enumeration value with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

value - The ordinal of the created enumeration value.

Returns:

The created enumeration value.

newAnonVal

<T extends java.lang.Enum<T>> HDF5EnumerationValue newAnonVal(java.lang.Enum<T> value)

Creates a new enumeration value with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValue(writer.getAnonymousEnumType(value.class), getClass()).

Parameters:

value - The value (including the type) of the created enumeration value.

Returns:

The created enumeration value.

newVal

<T extends java.lang.Enum<T>> HDF5EnumerationValue newVal(java.lang.Enum<T> value)

Creates a new enumeration value with an enumeration type of name value.getClass().getSimpleName().

Shortcut for new HDF5EnumerationValue(writer.getEnumType(value.getClass()), value).

Parameters:

value - The value (including the type) of the created enumeration value.

Returns:

The created enumeration value.

newVal

<T extends java.lang.Enum<T>> HDF5EnumerationValue newVal(java.lang.String typeName,
                                                          java.lang.Enum<T> value)

Creates a new enumeration value with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValue(writer.getEnumType(typeName, value.getClass()), value).

Parameters:

typeName - The name of the enumeration type.

value - The value (including the type) of the created enumeration value.

Returns:

The created enumeration value.

newArray

HDF5EnumerationValueArray newArray(java.lang.String typeName,
                                   java.lang.String[] options,
                                   java.lang.String[] values)

Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The string representations of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonArray

HDF5EnumerationValueArray newAnonArray(java.lang.String[] options,
                                       java.lang.String[] values)

Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

values - The string representations of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newArray

HDF5EnumerationValueArray newArray(java.lang.String typeName,
                                   java.lang.String[] options,
                                   int[] values)

Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonArray

HDF5EnumerationValueArray newAnonArray(java.lang.String[] options,
                                       int[] values)

Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newArray

HDF5EnumerationValueArray newArray(java.lang.String typeName,
                                   java.lang.String[] options,
                                   short[] values)

Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonArray

HDF5EnumerationValueArray newAnonArray(java.lang.String[] options,
                                       short[] values)

Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newArray

HDF5EnumerationValueArray newArray(java.lang.String typeName,
                                   java.lang.String[] options,
                                   byte[] values)

Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonArray

HDF5EnumerationValueArray newAnonArray(java.lang.String[] options,
                                       byte[] values)

Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonArray

<T extends java.lang.Enum<T>> HDF5EnumerationValueArray newAnonArray(java.lang.Enum<T>[] values)

Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(value.getClass().getComponentType()), value).

Parameters:

values - The value array (which has the type) of the created enumeration value array.

Returns:

The created enumeration value.

newArray

<T extends java.lang.Enum<T>> HDF5EnumerationValueArray newArray(java.lang.String typeName,
                                                                 java.lang.Enum<T>[] values)

Creates a new enumeration value array (of rank 1) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, value.getClass().getComponentType()), value).

Parameters:

typeName - The name of the enumeration type.

values - The value array (which has the type) of the created enumeration value array.

Returns:

The created enumeration value.

newArray

<T extends java.lang.Enum<T>> HDF5EnumerationValueArray newArray(java.lang.Enum<T>[] values)

Creates a new enumeration value array (of rank 1) with an enumeration type of name value.class.getSimpleName().

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(value.getClass().getComponentType()), value).

Parameters:

values - The value array (which has the type) of the created enumeration value array.

Returns:

The created enumeration value.

newMDArray

HDF5EnumerationValueMDArray newMDArray(java.lang.String typeName,
                                       java.lang.String[] options,
                                       ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> values)

Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The string representations of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonMDArray

HDF5EnumerationValueMDArray newAnonMDArray(java.lang.String[] options,
                                           ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> values)

Creates a new enumeration value array (of rank N) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

values - The string representations of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newMDArray

HDF5EnumerationValueMDArray newMDArray(java.lang.String typeName,
                                       java.lang.String[] options,
                                       ch.systemsx.cisd.base.mdarray.MDIntArray values)

Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonMDArray

HDF5EnumerationValueMDArray newAnonMDArray(java.lang.String[] options,
                                           ch.systemsx.cisd.base.mdarray.MDIntArray values)

Creates a new enumeration value array (of rank N) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newMDArray

HDF5EnumerationValueMDArray newMDArray(java.lang.String typeName,
                                       java.lang.String[] options,
                                       ch.systemsx.cisd.base.mdarray.MDShortArray values)

Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonMDArray

HDF5EnumerationValueMDArray newAnonMDArray(java.lang.String[] options,
                                           ch.systemsx.cisd.base.mdarray.MDShortArray values)

Creates a new enumeration value array (of rank N) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value).

Parameters:

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newMDArray

HDF5EnumerationValueMDArray newMDArray(java.lang.String typeName,
                                       java.lang.String[] options,
                                       ch.systemsx.cisd.base.mdarray.MDByteArray values)

Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

typeName - The name of the enumeration type.

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonMDArray

HDF5EnumerationValueMDArray newAnonMDArray(java.lang.String[] options,
                                           ch.systemsx.cisd.base.mdarray.MDByteArray values)

Creates a new enumeration value array (of rank N) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value).

Parameters:

options - The values of the enumeration type.

values - The ordinal values of the elements of the created enumeration value array.

Returns:

The created enumeration value.

newAnonMDArray

<T extends java.lang.Enum<T>> HDF5EnumerationValueMDArray newAnonMDArray(ch.systemsx.cisd.base.mdarray.MDArray<java.lang.Enum<T>> values)

Creates a new enumeration value array (of rank N) with an anonymous enumeration type.

Shortcut for new HDF5EnumerationValueArray(writer.getAnonymousEnumType(value.getAsFlatArray().getClass().getComponentType()), value).

Parameters:

values - The value array (which has the type) of the created enumeration value array.

Returns:

The created enumeration value.

newMDArray

<T extends java.lang.Enum<T>> HDF5EnumerationValueMDArray newMDArray(java.lang.String typeName,
                                                                     ch.systemsx.cisd.base.mdarray.MDArray<java.lang.Enum<T>> values)

Creates a new enumeration value array (of rank N) with an enumeration type of name typeName.

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(typeName, value.getAsFlatArray().getClass().getComponentType()), value).

Parameters:

typeName - The name of the enumeration type.

values - The value array (which has the type) of the created enumeration value array.

Returns:

The created enumeration value.

newMDArray

<T extends java.lang.Enum<T>> HDF5EnumerationValueMDArray newMDArray(ch.systemsx.cisd.base.mdarray.MDArray<java.lang.Enum<T>> values)

Creates a new enumeration value array (of rank N) with an enumeration type of name value.class.getSimpleName().

Shortcut for new HDF5EnumerationValueArray(writer.getEnumType(value.getAsFlatArray().getClass().getComponentType()), value).

Parameters:

values - The value array (which has the type) of the created enumeration value array.

Returns:

The created enumeration value.