ch.systemsx.cisd.hdf5

Class HDF5CompoundMemberInformation

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5CompoundMemberInformation

All Implemented Interfaces:

java.lang.Comparable<HDF5CompoundMemberInformation>

public final class HDF5CompoundMemberInformation
extends java.lang.Object
implements java.lang.Comparable<HDF5CompoundMemberInformation>

Contains information about one member of an HDF5 compound data type.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(HDF5CompoundMemberInformation o)
static HDF5CompoundMemberInformation[]	create(java.lang.Class<?> compoundClass, java.lang.String houseKeepingNameSuffix, HDF5CompoundMemberMapping... members) Creates the compound member information for the given compoundClass and members.
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name of the member.
int	getOffset() Deprecated. Use getOffsetOnDisk() instead.
int	getOffsetInMemory() Returns the byte offset of this member within the compound data type in memory.
int	getOffsetOnDisk() Returns the byte offset of this member within the compound data type on disk.
HDF5DataTypeInformation	getType() Returns the type information of the member.
int	hashCode()
java.lang.String	toString()
java.lang.String[]	tryGetEnumValues() Returns the values of the enumeration type of this compound member, if it is of an enumeration type and null otherwise.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the name of the member.

getType

public HDF5DataTypeInformation getType()

Returns the type information of the member.

tryGetEnumValues

public java.lang.String[] tryGetEnumValues()

Returns the values of the enumeration type of this compound member, if it is of an enumeration type and null otherwise.

getOffset

@Deprecated
public int getOffset()

Deprecated. Use getOffsetOnDisk() instead.

Returns the byte offset of this member within the compound data type, 0 meaning that the member is the first one in the compound data type.

getOffsetOnDisk

public int getOffsetOnDisk()

Returns the byte offset of this member within the compound data type on disk. 0 meaning that the member is the first one in the compound data type.

The on-disk representation is packed.

getOffsetInMemory

public int getOffsetInMemory()

Returns the byte offset of this member within the compound data type in memory. 0 meaning that the member is the first one in the compound data type.

The in-memory representation may contain padding to ensure that read access is always aligned.

create

public static HDF5CompoundMemberInformation[] create(java.lang.Class<?> compoundClass,
                                     java.lang.String houseKeepingNameSuffix,
                                     HDF5CompoundMemberMapping... members)

Creates the compound member information for the given compoundClass and members. The returned array will contain the members in the order of the members.

Call Arrays.sort(compoundInformation) to sort the array in alphabetical order of names.

Can be used to compare compound types, e.g. via Arrays.equals(Object[], Object[]).

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(HDF5CompoundMemberInformation o)

Specified by:

compareTo in interface java.lang.Comparable<HDF5CompoundMemberInformation>