TimeUnit (fr.lirmm.graphik:graal 1.3.1 API)

java.lang.Object
- java.lang.Enum<TimeUnit>
- - fr.lirmm.graphik.util.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>
```
public enum TimeUnit
extends Enum<TimeUnit>
```
Author:

Clément Sipieter (INRIA) <clement@6pi.fr>

Enum Constant Summary

Enum Constants
Enum Constant and Description

HOURS

MICROSECONDS

MILLISECONDS

MINUTES

NANOSECONDS

SECONDS

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`convert(long sourceDuration, TimeUnit sourceUnit)` Convert the given time duration in the given unit to this unit.
`String`	`getAbbreviation()` Return the abbreviation of this TimeUnit, "h" for hours, "min" for minutes, "s" for seconds, "ms" for milliseconds, "μs" for microseconds and "ns" for nanoseconds.
`long`	`round(long sourceDuration, TimeUnit timeUnit)` Round the given time duration in the given unit to this unit.
`long`	`roundToHours(long duration)` Equivalent to HOURS.round(duration, this).
`long`	`roundToMicros(long duration)` Equivalent to MICROSECONDS.round(duration, this).
`long`	`roundToMillis(long duration)` Equivalent to MILLISECONDS.round(duration, this).
`long`	`roundToMinutes(long duration)` Equivalent to MINUTES.round(duration, this).
`long`	`roundToNanos(long duration)` Equivalent to NANOSECONDS.round(duration, this).
`long`	`roundToSeconds(long duration)` Equivalent to SECONDS.round(duration, this).
`long`	`toHours(long duration)` Equivalent to HOURS.convert(duration, this).
`long`	`toMicros(long duration)` Equivalent to MICROSECONDS.convert(duration, this).
`long`	`toMillis(long duration)` Equivalent to MILLISECONDS.convert(duration, this).
`long`	`toMinutes(long duration)` Equivalent to MINUTES.convert(duration, this).
`long`	`toNanos(long duration)` Equivalent to NANOSECONDS.convert(duration, this).
`long`	`toSeconds(long duration)` Equivalent to SECONDS.convert(duration, this).
`String`	`toString()`
`static TimeUnit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TimeUnit[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - HOURS
```
public static final TimeUnit HOURS
```
  - MINUTES
```
public static final TimeUnit MINUTES
```
  - SECONDS
```
public static final TimeUnit SECONDS
```
  - MILLISECONDS
```
public static final TimeUnit MILLISECONDS
```
  - MICROSECONDS
```
public static final TimeUnit MICROSECONDS
```
  - NANOSECONDS
```
public static final TimeUnit NANOSECONDS
```
- Method Detail
  - values
```
public static TimeUnit[] 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 (TimeUnit c : TimeUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TimeUnit valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getAbbreviation
```
public String getAbbreviation()
```
    Return the abbreviation of this TimeUnit, "h" for hours, "min" for minutes, "s" for seconds, "ms" for milliseconds, "μs" for microseconds and "ns" for nanoseconds.
    
    Returns:
    
    the TimeUnit abbreviation.
  - convert
```
public long convert(long sourceDuration,
                    TimeUnit sourceUnit)
```
    Convert the given time duration in the given unit to this unit. Conversions from finer to coarser granularities truncate, so lose precision. For example converting 999 milliseconds to seconds results in 0. Conversions from coarser to finer granularities with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive. For example, to convert 10 minutes to milliseconds, use: TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
    
    Parameters:
    
    sourceDuration - the time duration in the given sourceUnit
    
    sourceUnit - the unit of the sourceDuration 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.
  - round
```
public long round(long sourceDuration,
                  TimeUnit timeUnit)
```
    Round the given time duration in the given unit to this unit. Conversions from finer to coarser granularities are rounded. For example converting 999 milliseconds to seconds results in 1, 500 also results in 1, 499 results in 0. Conversions from coarser to finer granularities is equivalent to this.convert(sourceDuration, timeUnit).
    
    Parameters:
    
    sourceDuration - the time duration in the given sourceUnit
    
    timeUnit - the unit of the sourceDuration argument
    
    Returns:
    
    the rounded duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
  - toHours
```
public long toHours(long duration)
```
    Equivalent to HOURS.convert(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the converted duration
  - toMicros
```
public long toMicros(long duration)
```
    Equivalent to MICROSECONDS.convert(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the converted duration
  - toMillis
```
public long toMillis(long duration)
```
    Equivalent to MILLISECONDS.convert(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the converted duration
  - toMinutes
```
public long toMinutes(long duration)
```
    Equivalent to MINUTES.convert(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the converted duration
  - toNanos
```
public long toNanos(long duration)
```
    Equivalent to NANOSECONDS.convert(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the converted duration
  - toSeconds
```
public long toSeconds(long duration)
```
    Equivalent to SECONDS.convert(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the converted duration
  - roundToHours
```
public long roundToHours(long duration)
```
    Equivalent to HOURS.round(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the rounded duration
  - roundToMicros
```
public long roundToMicros(long duration)
```
    Equivalent to MICROSECONDS.round(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the rounded duration
  - roundToMillis
```
public long roundToMillis(long duration)
```
    Equivalent to MILLISECONDS.round(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the rounded duration
  - roundToMinutes
```
public long roundToMinutes(long duration)
```
    Equivalent to MINUTES.round(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the rounded duration
  - roundToNanos
```
public long roundToNanos(long duration)
```
    Equivalent to NANOSECONDS.round(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the rounded duration
  - roundToSeconds
```
public long roundToSeconds(long duration)
```
    Equivalent to SECONDS.round(duration, this).
    
    Parameters:
    
    duration - the duration
    
    Returns:
    
    the rounded duration
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<TimeUnit>

Enum TimeUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

HOURS

MINUTES

SECONDS

MILLISECONDS

MICROSECONDS

NANOSECONDS

Method Detail

values

valueOf

getAbbreviation

convert

round

toHours

toMicros

toMillis

toMinutes

toNanos

toSeconds

roundToHours

roundToMicros

roundToMillis

roundToMinutes

roundToNanos

roundToSeconds

toString