HDF5TimeUnit (jhdf5 19.04.1 API)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HDF5TimeUnit>
```
public enum HDF5TimeUnit
extends java.lang.Enum<HDF5TimeUnit>
```
A TimeUnit represents a unit of a time duration. Each unit corresponds to one time duration HDF5DataTypeVariant.
The conversion of time durations is heavily inspired by Doug Lea's class in the Java runtime library.

Enum Constant Summary

Enum Constants
Enum Constant and Description

DAYS

HOURS

MICROSECONDS

MILLISECONDS

MINUTES

SECONDS

Enum Constants
Enum Constant and Description
`DAYS`
`HOURS`
`MICROSECONDS`
`MILLISECONDS`
`MINUTES`
`SECONDS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`convert(HDF5TimeDuration duration)` Convert the given time duration in the given unit to this unit.
`long[]`	`convert(HDF5TimeDuration[] durations)` Convert the given time `durations` to this unit.
`long[]`	`convert(HDF5TimeDurationArray durations)` Convert the given time `durations` in the given time `unit` to this unit.
`HDF5TimeDurationMDArray`	`convert(HDF5TimeDurationMDArray durations)` Convert the given time `durations` in the given time `unit` to this unit.
`long[]`	`convert(long[] durations, HDF5TimeUnit unit)` Convert the given time `durations` in the given time `unit` to this unit.
`long`	`convert(long duration, HDF5TimeUnit unit)` Convert the given time duration in the given unit to this unit.
`HDF5DataTypeVariant`	`getTypeVariant()` Returns the type variant corresponding to this unit.
`static HDF5TimeUnit`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static HDF5TimeUnit[]`	`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
  - MICROSECONDS
```
public static final HDF5TimeUnit MICROSECONDS
```
  - MILLISECONDS
```
public static final HDF5TimeUnit MILLISECONDS
```
  - SECONDS
```
public static final HDF5TimeUnit SECONDS
```
  - MINUTES
```
public static final HDF5TimeUnit MINUTES
```
  - HOURS
```
public static final HDF5TimeUnit HOURS
```
  - DAYS
```
public static final HDF5TimeUnit DAYS
```
- Method Detail
  - values
```
public static HDF5TimeUnit[] 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 (HDF5TimeUnit c : HDF5TimeUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HDF5TimeUnit 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
  - getTypeVariant
```
public HDF5DataTypeVariant getTypeVariant()
```
    Returns the type variant corresponding to this unit.
  - convert
```
public long convert(long duration,
                    HDF5TimeUnit unit)
```
    Convert the given time duration in the given unit to this unit. Conversions from smaller to larger units perform rounding, so they lose precision. Conversions from larger to smaller units with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.
    
    Parameters:
    
    duration - The time duration in the given unit.
    
    unit - The unit of the duration argument.
    
    Returns:
    
    The converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - convert
```
public long[] convert(HDF5TimeDurationArray durations)
```
    Convert the given time durations in the given time unit to this unit. Conversions from smaller to larger units perform rounding, so they lose precision. Conversions from larger to smaller units with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.
    
    Parameters:
    
    durations - The time durations.
    
    Returns:
    
    The converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - convert
```
public HDF5TimeDurationMDArray convert(HDF5TimeDurationMDArray durations)
```
    Convert the given time durations in the given time unit to this unit. Conversions from smaller to larger units perform rounding, so they lose precision. Conversions from larger to smaller units with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.
    
    Parameters:
    
    durations - The time durations.
    
    Returns:
    
    The converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - convert
```
public long[] convert(long[] durations,
                      HDF5TimeUnit unit)
```
    Convert the given time durations in the given time unit to this unit. Conversions from smaller to larger units perform rounding, so they lose precision. Conversions from larger to smaller units with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.
    
    Parameters:
    
    durations - The time duration in the given unit.
    
    unit - The unit of the duration argument.
    
    Returns:
    
    The converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - convert
```
public long convert(HDF5TimeDuration duration)
```
    Convert the given time duration in the given unit to this unit. Conversions from smaller to larger units perform rounding, so they lose precision. Conversions from larger to smaller units with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.
    
    Parameters:
    
    duration - The time duration and its unit.
    
    Returns:
    
    The converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - convert
```
public long[] convert(HDF5TimeDuration[] durations)
```
    Convert the given time durations to this unit. Conversions from smaller to larger units perform rounding, so they lose precision. Conversions from larger to smaller units with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.
    
    Returns:
    
    The converted durations in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

Enum HDF5TimeUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

Method Detail

values

valueOf

getTypeVariant

convert

convert

convert

convert

convert

convert