HDF5DataTypeVariant (jhdf5 19.04.1 API)

java.lang.Object
- java.lang.Enum<HDF5DataTypeVariant>
- - ch.systemsx.cisd.hdf5.HDF5DataTypeVariant

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HDF5DataTypeVariant>
```
public enum HDF5DataTypeVariant
extends java.lang.Enum<HDF5DataTypeVariant>
```
An enum of all type variants. Type variants contain additional information on how to interpret a data set, similar to the tag for the opaque type.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BITFIELD`
`ENUM` An enumeration.
`NONE` No type variant.
`TIME_DURATION_DAYS` A time duration in days.
`TIME_DURATION_HOURS` A time duration in hours.
`TIME_DURATION_MICROSECONDS` A time duration in micro-seconds.
`TIME_DURATION_MILLISECONDS` A time duration in milli-seconds.
`TIME_DURATION_MINUTES` A time duration in minutes.
`TIME_DURATION_SECONDS` A time duration in seconds.
`TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH` Used for data sets that encode time stamps as number of milli-seconds since midnight, January 1, 1970 UTC (aka "start of the epoch").

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HDF5TimeUnit`	`getTimeUnit(HDF5DataTypeVariant typeVariant)` Returns the time unit for the given `typeVariant`.
`static HDF5TimeUnit`	`getTimeUnit(int typeVariantOrdinal)` Returns the time unit for the given `typeVariantOrdinal`.
`boolean`	`isCompatible(java.lang.Class<?> type)` Returns `true` if `type` is compatible with this type variant.
`boolean`	`isTimeDuration()` Returns `true`, if this type variant corresponds to a time duration.
`static boolean`	`isTimeDuration(int typeVariantOrdinal)` Returns `true`, if the type variant denoted by `typeVariantOrdinal` corresponds to a time duration.
`boolean`	`isTimeStamp()` Returns `true`, if this type variant corresponds to a time stamp.
`boolean`	`isTypeVariant()` Returns `true`, if this type variant is not `NONE`.
`static boolean`	`isTypeVariant(HDF5DataTypeVariant typeVariantOrNull)` Returns `true`, if `typeVariantOrNull` is not `nullNONE`.
`static boolean`	`isTypeVariant(int typeVariantOrdinal)` Returns `true`, if `typeVariantOrdinal` does not represent `NONE`.
`static HDF5DataTypeVariant`	`maskNull(HDF5DataTypeVariant typeVariantOrNull)` Returns `typeVariantOrNull`, if it is not `null`, and `NONE` otherwise.
`HDF5TimeUnit`	`tryGetTimeUnit()` Returns the time unit for this type variant or `null`, if this type variant is not a time unit.
`static HDF5DataTypeVariant`	`unmaskNone(HDF5DataTypeVariant typeVariantOrNull)` Returns `typeVariantOrNull`, if it is not `NONE`, and `null` otherwise.
`static HDF5DataTypeVariant`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static HDF5DataTypeVariant[]`	`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
  - TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH
```
public static final HDF5DataTypeVariant TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH
```
    Used for data sets that encode time stamps as number of milli-seconds since midnight, January 1, 1970 UTC (aka "start of the epoch").
  - TIME_DURATION_MICROSECONDS
```
public static final HDF5DataTypeVariant TIME_DURATION_MICROSECONDS
```
    A time duration in micro-seconds.
  - TIME_DURATION_MILLISECONDS
```
public static final HDF5DataTypeVariant TIME_DURATION_MILLISECONDS
```
    A time duration in milli-seconds.
  - TIME_DURATION_SECONDS
```
public static final HDF5DataTypeVariant TIME_DURATION_SECONDS
```
    A time duration in seconds.
  - TIME_DURATION_MINUTES
```
public static final HDF5DataTypeVariant TIME_DURATION_MINUTES
```
    A time duration in minutes.
  - TIME_DURATION_HOURS
```
public static final HDF5DataTypeVariant TIME_DURATION_HOURS
```
    A time duration in hours.
  - TIME_DURATION_DAYS
```
public static final HDF5DataTypeVariant TIME_DURATION_DAYS
```
    A time duration in days.
  - ENUM
```
public static final HDF5DataTypeVariant ENUM
```
    An enumeration.
  - NONE
```
public static final HDF5DataTypeVariant NONE
```
    No type variant.
  - BITFIELD
```
public static final HDF5DataTypeVariant BITFIELD
```
- Method Detail
  - values
```
public static HDF5DataTypeVariant[] 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 (HDF5DataTypeVariant c : HDF5DataTypeVariant.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HDF5DataTypeVariant 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
  - isTypeVariant
```
public static boolean isTypeVariant(HDF5DataTypeVariant typeVariantOrNull)
```
    Returns true, if typeVariantOrNull is not nullNONE.
  - isTypeVariant
```
public static boolean isTypeVariant(int typeVariantOrdinal)
```
    Returns true, if typeVariantOrdinal does not represent NONE.
  - maskNull
```
public static HDF5DataTypeVariant maskNull(HDF5DataTypeVariant typeVariantOrNull)
```
    Returns typeVariantOrNull, if it is not null, and NONE otherwise.
  - unmaskNone
```
public static HDF5DataTypeVariant unmaskNone(HDF5DataTypeVariant typeVariantOrNull)
```
    Returns typeVariantOrNull, if it is not NONE, and null otherwise.
  - isTypeVariant
```
public boolean isTypeVariant()
```
    Returns true, if this type variant is not NONE.
  - isTimeDuration
```
public static boolean isTimeDuration(int typeVariantOrdinal)
```
    Returns true, if the type variant denoted by typeVariantOrdinal corresponds to a time duration.
  - isCompatible
```
public boolean isCompatible(java.lang.Class<?> type)
```
    Returns true if type is compatible with this type variant.
  - getTimeUnit
```
public static HDF5TimeUnit getTimeUnit(HDF5DataTypeVariant typeVariant)
```
    Returns the time unit for the given typeVariant. Note that it is an error if typeVariant does not correspond to a time unit.
  - getTimeUnit
```
public static HDF5TimeUnit getTimeUnit(int typeVariantOrdinal)
```
    Returns the time unit for the given typeVariantOrdinal. Note that it is an error if typeVariantOrdinal does not correspond to a time unit.
  - isTimeStamp
```
public boolean isTimeStamp()
```
    Returns true, if this type variant corresponds to a time stamp.
  - isTimeDuration
```
public boolean isTimeDuration()
```
    Returns true, if this type variant corresponds to a time duration.
  - tryGetTimeUnit
```
public HDF5TimeUnit tryGetTimeUnit()
```
    Returns the time unit for this type variant or null, if this type variant is not a time unit.

Enum HDF5DataTypeVariant

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH

TIME_DURATION_MICROSECONDS

TIME_DURATION_MILLISECONDS

TIME_DURATION_SECONDS

TIME_DURATION_MINUTES

TIME_DURATION_HOURS

TIME_DURATION_DAYS

ENUM

NONE

BITFIELD

Method Detail

values

valueOf

isTypeVariant

isTypeVariant

maskNull

unmaskNone

isTypeVariant

isTimeDuration

isCompatible

getTimeUnit

getTimeUnit

isTimeStamp

isTimeDuration

tryGetTimeUnit