ch.systemsx.cisd.hdf5

Enum HDF5ObjectType

java.lang.Object

java.lang.Enum<HDF5ObjectType>

ch.systemsx.cisd.hdf5.HDF5ObjectType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HDF5ObjectType>

public enum HDF5ObjectType
extends java.lang.Enum<HDF5ObjectType>

An enumeration that represents the basic HDF5 object types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATASET
DATATYPE
EXTERNAL_LINK
GROUP
NONEXISTENT
OTHER
SOFT_LINK

Method Summary

Modifier and Type	Method and Description
static boolean	exists(HDF5ObjectType objectType) Returns false, if the objectTypeOrNull is equal to NONEXISTENT and true otherwise.
static boolean	isDataSet(HDF5ObjectType objectType) Returns true, if the objectTypeOrNull is equal to DATASET and false otherwise.
static boolean	isDataType(HDF5ObjectType objectType) Returns true, if the objectTypeOrNull is equal to DATATYPE and false otherwise.
static boolean	isExternalLink(HDF5ObjectType objectType) Returns true, if the objectTypeOrNull is equal to EXTERNAL_LINK and false otherwise.
static boolean	isGroup(HDF5ObjectType objectType) Returns true, if the objectTypeOrNull is equal to GROUP and false otherwise.
static boolean	isSoftLink(HDF5ObjectType objectType) Returns true, if the objectTypeOrNull is equal to SOFT_LINK and false otherwise.
static boolean	isSymbolicLink(HDF5ObjectType objectType) Returns true, if the objectTypeOrNull is equal to either SOFT_LINK or EXTERNAL_LINK.
static HDF5ObjectType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HDF5ObjectType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DATASET

public static final HDF5ObjectType DATASET

DATATYPE

public static final HDF5ObjectType DATATYPE

GROUP

public static final HDF5ObjectType GROUP

SOFT_LINK

public static final HDF5ObjectType SOFT_LINK

EXTERNAL_LINK

public static final HDF5ObjectType EXTERNAL_LINK

OTHER

public static final HDF5ObjectType OTHER

NONEXISTENT

public static final HDF5ObjectType NONEXISTENT

Method Detail

values

public static HDF5ObjectType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HDF5ObjectType c : HDF5ObjectType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HDF5ObjectType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

exists

public static boolean exists(HDF5ObjectType objectType)

Returns false, if the objectTypeOrNull is equal to NONEXISTENT and true otherwise.

Parameters:

objectType - The object type to check.

isGroup

public static boolean isGroup(HDF5ObjectType objectType)

Returns true, if the objectTypeOrNull is equal to GROUP and false otherwise.

Parameters:

objectType - The object type to check.

isDataSet

public static boolean isDataSet(HDF5ObjectType objectType)

Returns true, if the objectTypeOrNull is equal to DATASET and false otherwise.

Parameters:

objectType - The object type to check.

isDataType

public static boolean isDataType(HDF5ObjectType objectType)

Returns true, if the objectTypeOrNull is equal to DATATYPE and false otherwise.

Parameters:

objectType - The object type to check.

isSoftLink

public static boolean isSoftLink(HDF5ObjectType objectType)

Returns true, if the objectTypeOrNull is equal to SOFT_LINK and false otherwise.

Parameters:

objectType - The object type to check.

isExternalLink

public static boolean isExternalLink(HDF5ObjectType objectType)

Returns true, if the objectTypeOrNull is equal to EXTERNAL_LINK and false otherwise.

Parameters:

objectType - The object type to check (can be null).

isSymbolicLink

public static boolean isSymbolicLink(HDF5ObjectType objectType)

Returns true, if the objectTypeOrNull is equal to either SOFT_LINK or EXTERNAL_LINK. and false otherwise.

Parameters:

objectType - The object type to check.