ch.systemsx.cisd.hdf5

Class HDF5CompoundMappingHints

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5CompoundMappingHints

public class HDF5CompoundMappingHints
extends java.lang.Object

A class to store general hints that can influence the compound member mapping.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HDF5CompoundMappingHints.EnumReturnType

Constructor Summary

Constructors

Constructor and Description
HDF5CompoundMappingHints()

Method Summary

Modifier and Type	Method and Description
HDF5CompoundMappingHints	enumReturnType(HDF5CompoundMappingHints.EnumReturnType enumReturnType) Sets the return type for enums .
HDF5CompoundMappingHints	enumTypeMapping(java.util.Map<java.lang.String,HDF5EnumerationType> enumTypeMapping) Replaces the enum type mapping of this hints object.
HDF5CompoundMappingHints	enumTypeMapping(java.lang.String memberName, HDF5EnumerationType enumType) Adds an enum type mapping to this hints object.
HDF5CompoundMappingHints.EnumReturnType	getEnumReturnType() Returns the desired return type for enums.
static HDF5CompoundMappingHints.EnumReturnType	getEnumReturnType(HDF5CompoundMemberMapping mapping) Returns the desired enumeration return type.
boolean	isUseVariableLengthStrings() Returns whether variable-length-string types should be used if the length is not set explicitly.
static boolean	isUseVariableLengthStrings(HDF5CompoundMappingHints hintsOrNull) Returns whether variable-length-string types should be used if the length is not set explicitly.
void	setEnumReturnType(HDF5CompoundMappingHints.EnumReturnType enumReturnType) Sets the desired return type for enums.
void	setUseVariableLengthStrings(boolean useVariableLengthStrings) Sets whether variable-length-string types should be used if the length is not set explicitly.
HDF5EnumerationType	tryGetEnumType(java.lang.String memberName) Returns the HDF5EnumerationType for the given memberName, or null, if no mapping is available for this member.
HDF5CompoundMappingHints	useVariableLengthStrings() Sets that variable-length-string types should be used if the length is not set explicitly.
HDF5CompoundMappingHints	useVariableLengthStrings(boolean useVariableLengthStrings) Sets whether variable-length-string types should be used if the length is not set explicitly.

Methods inherited from class java.lang.Object

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

Constructor Detail

HDF5CompoundMappingHints

public HDF5CompoundMappingHints()

Method Detail

getEnumReturnType

public HDF5CompoundMappingHints.EnumReturnType getEnumReturnType()

Returns the desired return type for enums.

setEnumReturnType

public void setEnumReturnType(HDF5CompoundMappingHints.EnumReturnType enumReturnType)

Sets the desired return type for enums.

enumReturnType

public HDF5CompoundMappingHints enumReturnType(HDF5CompoundMappingHints.EnumReturnType enumReturnType)

Sets the return type for enums .

Returns:

This object (for chaining)

enumTypeMapping

public HDF5CompoundMappingHints enumTypeMapping(java.lang.String memberName,
                                                HDF5EnumerationType enumType)

Adds an enum type mapping to this hints object.

Returns:

The hint object.

enumTypeMapping

public HDF5CompoundMappingHints enumTypeMapping(java.util.Map<java.lang.String,HDF5EnumerationType> enumTypeMapping)

Replaces the enum type mapping of this hints object.

Returns:

The hint object.

tryGetEnumType

public HDF5EnumerationType tryGetEnumType(java.lang.String memberName)

Returns the HDF5EnumerationType for the given memberName, or null, if no mapping is available for this member.

getEnumReturnType

public static HDF5CompoundMappingHints.EnumReturnType getEnumReturnType(HDF5CompoundMemberMapping mapping)

Returns the desired enumeration return type.

isUseVariableLengthStrings

public static boolean isUseVariableLengthStrings(HDF5CompoundMappingHints hintsOrNull)

Returns whether variable-length-string types should be used if the length is not set explicitly.

isUseVariableLengthStrings

public boolean isUseVariableLengthStrings()

Returns whether variable-length-string types should be used if the length is not set explicitly.

setUseVariableLengthStrings

public void setUseVariableLengthStrings(boolean useVariableLengthStrings)

Sets whether variable-length-string types should be used if the length is not set explicitly.

useVariableLengthStrings

public HDF5CompoundMappingHints useVariableLengthStrings()

Sets that variable-length-string types should be used if the length is not set explicitly.

Returns:

The hint object.

useVariableLengthStrings

public HDF5CompoundMappingHints useVariableLengthStrings(boolean useVariableLengthStrings)

Sets whether variable-length-string types should be used if the length is not set explicitly.

Returns:

The hint object.