Duration (nf-commons 20.01.0-edge API)

nextflow.util.Duration

All Implemented Interfaces and Traits:: java.lang.Comparable, java.io.Serializable, java.lang.Cloneable

@groovy.util.logging.Slf4j
@groovy.transform.CompileStatic
@groovy.transform.EqualsAndHashCode(includes = 'durationInMillis')
class Duration
extends java.lang.Object

A simple time duration representation

Authors:: Paolo Di Tommaso

Field Summary

Fields
Modifiers	Name	Description
`static java.util.List<java.lang.String>`	`UNITS`

Properties Summary

Properties
Type	Name and description
`long`	`durationInMillis` Duration in millis

Constructor Summary

Constructors
Constructor and description
`Duration (long duration)` Create e a duration object having the specified number of millis
`Duration (java.lang.String str)` Create the object using a string 'duration' format.
`Duration (long value, java.util.concurrent.TimeUnit unit)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`asBoolean()`
	`static Duration`	`between(java.time.temporal.Temporal start, java.time.temporal.Temporal end)`
	`int`	`compareTo(Duration that)`
	`static int`	`compareTo(Duration left, java.lang.Object right)`
	`java.lang.Object`	`div(java.lang.Number value)`
	`java.lang.String`	`format(java.lang.String fmt)` Duration formatting utilities and constants.
	`long`	`getDays()`
	`long`	`getHours()`
	`long`	`getMillis()`
	`long`	`getMinutes()`
	`long`	`getSeconds()`
	`java.lang.Object`	`minus(Duration value)`
	`java.lang.Object`	`multiply(java.lang.Number value)`
	`static Duration`	`of(long value)`
	`static Duration`	`of(java.lang.String str)`
	`static Duration`	`of(java.lang.String str, Duration fallback)`
	`java.lang.Object`	`plus(Duration value)`
	`long`	`toDays()`
	`long`	`toHours()`
	`long`	`toMillis()`
	`long`	`toMinutes()`
	`long`	`toSeconds()`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.util.List<java.lang.String> UNITS
- Property Detail
  - final long durationInMillis
    
    Duration in millis
- Constructor Detail
  - Duration(long duration)
    
    Create e a duration object having the specified number of millis
    Parameters:
    duration - The duration as milliseconds
  - Duration(java.lang.String str)
    
    Create the object using a string 'duration' format. Accepted prefix are:
  - ms, milli, millis: for milliseconds
  - s, second, seconds: for seconds
  - m, minute, minutes: for minutes
  - h, hour, hours: for hours
  - d, day, days: for days
    Parameters:
    str
  - Duration(long value, java.util.concurrent.TimeUnit unit)
- Method Detail
  - boolean asBoolean()
  - static Duration between(java.time.temporal.Temporal start, java.time.temporal.Temporal end)
  - @java.lang.Override int compareTo(Duration that)
  - static int compareTo(Duration left, java.lang.Object right)
  - java.lang.Object div(java.lang.Number value)
  - java.lang.String format(java.lang.String fmt)
    
    Duration formatting utilities and constants. The following table describes the tokens used in the pattern language for formatting.
```
   character	duration element
   y	        years
   d	        days
   H	        hours
   m	        minutes
   s	        seconds
 
```
    Parameters:
    fmt
    Returns:
  - long getDays()
  - long getHours()
  - long getMillis()
  - long getMinutes()
  - long getSeconds()
  - java.lang.Object minus(Duration value)
  - java.lang.Object multiply(java.lang.Number value)
  - static Duration of(long value)
  - static Duration of(java.lang.String str)
  - static Duration of(java.lang.String str, Duration fallback)
  - java.lang.Object plus(Duration value)
  - long toDays()
  - long toHours()
  - long toMillis()
  - long toMinutes()
  - long toSeconds()
  - java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Duration

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.util.List<java.lang.String> UNITS

Property Detail

final long durationInMillis

Constructor Detail

Duration(long duration)

Duration(java.lang.String str)

Duration(long value, java.util.concurrent.TimeUnit unit)

Method Detail

boolean asBoolean()

static Duration between(java.time.temporal.Temporal start, java.time.temporal.Temporal end)

@java.lang.Override int compareTo(Duration that)

static int compareTo(Duration left, java.lang.Object right)

java.lang.Object div(java.lang.Number value)

java.lang.String format(java.lang.String fmt)

long getDays()

long getHours()

long getMillis()

long getMinutes()

long getSeconds()

java.lang.Object minus(Duration value)

java.lang.Object multiply(java.lang.Number value)

static Duration of(long value)

static Duration of(java.lang.String str)

static Duration of(java.lang.String str, Duration fallback)

java.lang.Object plus(Duration value)

long toDays()

long toHours()

long toMillis()

long toMinutes()

long toSeconds()

java.lang.String toString()