Duration (Awaitility 2.0.0 API)

java.lang.Object
- org.awaitility.Duration

All Implemented Interfaces:: Comparable<Duration>

public class Duration
extends Object
implements Comparable<Duration>

Duration class.

Field Summary

Fields
Modifier and Type	Field and Description
`static Duration`	`FIVE_HUNDRED_MILLISECONDS` Constant `FIVE_HUNDRED_MILLISECONDS`
`static Duration`	`FIVE_MINUTES` Constant `FIVE_MINUTES`
`static Duration`	`FIVE_SECONDS` Constant `FIVE_SECONDS`
`static Duration`	`FOREVER` Constant `FOREVER`
`static Duration`	`ONE_HUNDRED_MILLISECONDS` Constant `ONE_HUNDRED_MILLISECONDS`
`static Duration`	`ONE_MILLISECOND` Constant `ONE_MILLISECOND`
`static Duration`	`ONE_MINUTE` Constant `ONE_MINUTE`
`static Duration`	`ONE_SECOND` Constant `ONE_SECOND`
`static Duration`	`SAME_AS_POLL_INTERVAL` Deprecated. This doesn't do anything. The initial delay is now always the same as poll interval if nothing else is specified.
`static Duration`	`TEN_MINUTES` Constant `TEN_MINUTES`
`static Duration`	`TEN_SECONDS` Constant `TEN_SECONDS`
`static Duration`	`TWO_HUNDRED_MILLISECONDS` Constant `TWO_HUNDRED_MILLISECONDS`
`static Duration`	`TWO_MINUTES` Constant `TWO_MINUTES`
`static Duration`	`TWO_SECONDS` Constant `TWO_SECONDS`
`static Duration`	`ZERO` Constant `ZERO`

Constructor Summary

Constructors
Constructor and Description

Duration(long value, TimeUnit unit)
Constructor for Duration.

Constructors
Constructor and Description
`Duration(long value, TimeUnit unit)` Constructor for Duration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Duration other)`
`Duration`	`divide(long amount)` Divide this duration amount with the given amount
`boolean`	`equals(Object o)`
`TimeUnit`	`getTimeUnit()` getTimeUnit.
`String`	`getTimeUnitAsString()` getTimeUnitAsString.
`long`	`getValue()` Getter for the field `value`.
`long`	`getValueInMS()` getValueInMS.
`int`	`hashCode()`
`boolean`	`isForever()` isForever.
`boolean`	`isZero()` isZero
`Duration`	`minus(Duration duration)` Add a duration with the given time unit.
`Duration`	`minus(long amount)` Subtract an amount (with the same time unit as the current amount)
`Duration`	`minus(long amount, TimeUnit timeUnit)` Subtract an amount with the given time unit.
`Duration`	`multiply(long amount)` Multiply this amount with the given amount
`Duration`	`plus(Duration duration)` Add a duration with the given time unit.
`Duration`	`plus(long amount)` Add a amount (with the same time unit as the current duration)
`Duration`	`plus(long amount, TimeUnit timeUnit)` Add a amount with the given time unit.
`String`	`toString()`

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

- Field Detail
  - FOREVER
```
public static final Duration FOREVER
```
    Constant FOREVER
  - ZERO
```
public static final Duration ZERO
```
    Constant ZERO
  - ONE_MILLISECOND
```
public static final Duration ONE_MILLISECOND
```
    Constant ONE_MILLISECOND
    
    Since:
    
    1.7.0
  - ONE_HUNDRED_MILLISECONDS
```
public static final Duration ONE_HUNDRED_MILLISECONDS
```
    Constant ONE_HUNDRED_MILLISECONDS
  - TWO_HUNDRED_MILLISECONDS
```
public static final Duration TWO_HUNDRED_MILLISECONDS
```
    Constant TWO_HUNDRED_MILLISECONDS
  - FIVE_HUNDRED_MILLISECONDS
```
public static final Duration FIVE_HUNDRED_MILLISECONDS
```
    Constant FIVE_HUNDRED_MILLISECONDS
  - ONE_SECOND
```
public static final Duration ONE_SECOND
```
    Constant ONE_SECOND
  - TWO_SECONDS
```
public static final Duration TWO_SECONDS
```
    Constant TWO_SECONDS
  - FIVE_SECONDS
```
public static final Duration FIVE_SECONDS
```
    Constant FIVE_SECONDS
  - TEN_SECONDS
```
public static final Duration TEN_SECONDS
```
    Constant TEN_SECONDS
  - ONE_MINUTE
```
public static final Duration ONE_MINUTE
```
    Constant ONE_MINUTE
  - TWO_MINUTES
```
public static final Duration TWO_MINUTES
```
    Constant TWO_MINUTES
  - FIVE_MINUTES
```
public static final Duration FIVE_MINUTES
```
    Constant FIVE_MINUTES
  - TEN_MINUTES
```
public static final Duration TEN_MINUTES
```
    Constant TEN_MINUTES
  - SAME_AS_POLL_INTERVAL
```
@Deprecated
public static final Duration SAME_AS_POLL_INTERVAL
```
    Deprecated. This doesn't do anything. The initial delay is now always the same as poll interval if nothing else is specified.
    
    Constant SAME_AS_POLL_INTERVAL
- Constructor Detail
  - Duration
```
public Duration(long value,
                TimeUnit unit)
```
    Constructor for Duration.
    
    Parameters:
    
    value - a long.
    
    unit - a TimeUnit object.
- Method Detail
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
    getTimeUnit.
    
    Returns:
    
    a TimeUnit object.
  - getTimeUnitAsString
```
public String getTimeUnitAsString()
```
    getTimeUnitAsString.
    
    Returns:
    
    a String object.
  - isForever
```
public boolean isForever()
```
    isForever.
    
    Returns:
    
    a boolean.
  - isZero
```
public boolean isZero()
```
    isZero
    
    Returns:
    
    a boolean.
  - getValue
```
public long getValue()
```
    Getter for the field value.
    
    Returns:
    
    a long.
  - getValueInMS
```
public long getValueInMS()
```
    getValueInMS.
    
    Returns:
    
    a long.
  - plus
```
public Duration plus(long amount)
```
    Add a amount (with the same time unit as the current duration)
    
    Parameters:
    
    amount - The amount to add
    
    Returns:
    
    A new amount
  - plus
```
public Duration plus(long amount,
                     TimeUnit timeUnit)
```
    Add a amount with the given time unit. For example:
```
 new Duration(2, SECONDS).plus(4, MILLISECONDS)
 
```
    will return a Duration of 2004 TimeUnit.MILLISECONDS.
```
 new Duration(2, SECONDS).plus(1, MINUTES)
 
```
    will return a Duration of 62 TimeUnit.SECONDS.
    Parameters:
    
    amount - The amount to add
    
    timeUnit - The time unit to add
    
    Returns:
    
    A new amount
  - plus
```
public Duration plus(Duration duration)
```
    Add a duration with the given time unit. For example:
```
 new Duration(2, SECONDS).plus(Duration.FIVE_HUNDRED_MILLISECONDS)
 
```
    will return a Duration of 2500 TimeUnit.MILLISECONDS.
    Parameters:
    
    duration - The duration to add
    
    Returns:
    
    A new duration
  - multiply
```
public Duration multiply(long amount)
```
    Multiply this amount with the given amount
    
    Parameters:
    
    amount - The amount
    
    Returns:
    
    A new amount
  - divide
```
public Duration divide(long amount)
```
    Divide this duration amount with the given amount
    
    Parameters:
    
    amount - The amount
    
    Returns:
    
    A new amount
  - minus
```
public Duration minus(long amount)
```
    Subtract an amount (with the same time unit as the current amount)
    
    Parameters:
    
    amount - The amount to add
    
    Returns:
    
    A new amount
  - minus
```
public Duration minus(long amount,
                      TimeUnit timeUnit)
```
    Subtract an amount with the given time unit. For example:
```
 new Duration(2, SECONDS).minus(4, MILLISECONDS)
 
```
    will return a Duration of 1996 TimeUnit.MILLISECONDS.
```
 new Duration(2, MINUTES).minus(1, SECONDS)
 
```
    will return a Duration of 119 TimeUnit.SECONDS.
    Parameters:
    
    amount - The amount to add
    
    timeUnit - The time unit to add
    
    Returns:
    
    A new amount
  - minus
```
public Duration minus(Duration duration)
```
    Add a duration with the given time unit. For example:
```
 new Duration(2, SECONDS).plus(Duration.FIVE_HUNDRED_MILLISECONDS)
 
```
    will return a Duration of 2500 TimeUnit.MILLISECONDS.
    Parameters:
    
    duration - The duration to add
    
    Returns:
    
    A new duration
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(Duration other)
```
    Specified by:
    
    compareTo in interface Comparable<Duration>

Class Duration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FOREVER

ZERO

ONE_MILLISECOND

ONE_HUNDRED_MILLISECONDS

TWO_HUNDRED_MILLISECONDS

FIVE_HUNDRED_MILLISECONDS

ONE_SECOND

TWO_SECONDS

FIVE_SECONDS

TEN_SECONDS

ONE_MINUTE

TWO_MINUTES

FIVE_MINUTES

TEN_MINUTES

SAME_AS_POLL_INTERVAL

Constructor Detail

Duration

Method Detail

getTimeUnit

getTimeUnitAsString

isForever

isZero

getValue

getValueInMS

plus

plus

plus

multiply

divide

minus

minus

minus

equals

hashCode

toString

compareTo