Duration (Pitaya 0.3 API)

java.lang.Object
- org.kocakosm.pitaya.time.Duration

All Implemented Interfaces:

Serializable, Comparable<Duration>
```
public final class Duration
extends Object
implements Comparable<Duration>, Serializable
```
A duration. Instances of this class are immutable. Implementation note: the duration is stored as milliseconds in a long value, thus some methods on this class are subject to overflow.

Author:

Osman KOCAK

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Duration`	`ONE_DAY` One day.
`static Duration`	`ONE_HOUR` One hour.
`static Duration`	`ONE_MILLISECOND` One millisecond.
`static Duration`	`ONE_MINUTE` One minute.
`static Duration`	`ONE_SECOND` One second.
`static Duration`	`ONE_WEEK` One week.
`static Duration`	`ZERO` Zero millisecond.

Method Summary

Methods
Modifier and Type	Method and Description
`Duration`	`absoluteValue()` Returns a copy of this duration with a positive length.
`Date`	`after(Date d)` Returns the date obtained by adding this duration to the given date.
`Date`	`before(Date d)` Returns the date obtained by subtracting this duration from the given date.
`static Duration`	`between(Date start, Date end)` Creates a new `Duration` instance representing the amount of time elapsed between the given dates.
`int`	`compareTo(Duration d)`
`Duration`	`dividedBy(int divisor)` Returns the result of dividing this duration by the given divisor.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`Duration`	`minus(Duration d)` Returns the result of subtracting the given duration from this one.
`Duration`	`multipliedBy(int factor)` Returns the result of multiplying this duration by the given factor.
`Duration`	`negated()` Returns the result of negating this duration.
`static Duration`	`of(Duration... durations)` Creates a new `Duration` instance by summing all the given `Duration`s' values.
`static Duration`	`of(long amount, TimeUnit unit)` Creates a new `Duration` representing the given amount in the given unit.
`static Duration`	`parse(String duration)` Parses the given duration's `String` representation into a `Duration` instance.
`Duration`	`plus(Duration d)` Returns the result of adding the given duration to this duration.
`int`	`sign()` Returns the sign of this duration, namely it returns `1` if this duration is positive, `0` if it is equal to `0`, and `-1` if it is negative.
`static Duration`	`since(Date d)` Creates a new `Duration` instance representing the amount of time elapsed since the given date.
`long`	`to(TimeUnit unit)` Converts this duration into the given unit.
`long`	`toMilliseconds()` Returns the number of milliseconds in this duration.
`String`	`toString()`
`static Duration`	`until(Date d)` Creates a new `Duration` instance representing the amount of time that will elapse until the given date.

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

- Field Detail
  - ZERO
```
public static final Duration ZERO
```
    Zero millisecond.
  - ONE_MILLISECOND
```
public static final Duration ONE_MILLISECOND
```
    One millisecond.
  - ONE_SECOND
```
public static final Duration ONE_SECOND
```
    One second.
  - ONE_MINUTE
```
public static final Duration ONE_MINUTE
```
    One minute.
  - ONE_HOUR
```
public static final Duration ONE_HOUR
```
    One hour.
  - ONE_DAY
```
public static final Duration ONE_DAY
```
    One day.
  - ONE_WEEK
```
public static final Duration ONE_WEEK
```
    One week.
- Method Detail
  - parse
```
public static Duration parse(String duration)
```
    Parses the given duration's String representation into a Duration instance. The given String must be a list of value/unit pairs separated by ' ', '+', '-', '\n', '\t', '\r', '&' or ',' characters or by the "and" String. Values must be integer (either positive or negative) values. Valid units are: "milliseconds", "millisecond", "millis" and "ms" for milliseconds, "seconds", "second", "sec", "secs" and "s" for seconds, "minutes", "minute", "min", "mins" and "m" for minutes, "hours", "hour" and "h" for hours, "days", "day" and "d" for days. Values must be separated from their unit by a whitespace character. Parsing is not case sensitive.
    
    Parameters:
    duration - the String to parse into a Duration.
    
    Returns:
    the parsed Duration.
    
    Throws:
    
    NullPointerException - if duration is null.
    
    IllegalArgumentException - if duration can't be parsed.
    
    ArithmeticException - if the total duration value overflows the storage capacity of this class.
  - of
```
public static Duration of(long amount,
          TimeUnit unit)
```
    Creates a new Duration representing the given amount in the given unit.
    
    Parameters:
    amount - the amount.
    unit - the unit in which the amout is given.
    
    Returns:
    the created Duration instance.
    
    Throws:
    
    NullPointerException - if unit is null.
    
    ArithmeticException - if the resulting duration is too large.
  - of
```
public static Duration of(Duration... durations)
```
    Creates a new Duration instance by summing all the given Durations' values.
    
    Parameters:
    durations - the Durations to sum.
    
    Returns:
    the created Duration.
    
    Throws:
    
    NullPointerException - if durations is null or if it contains null reference.
    
    ArithmeticException - if the resulting duration is too large.
  - between
```
public static Duration between(Date start,
               Date end)
```
    Creates a new Duration instance representing the amount of time elapsed between the given dates.
    
    Parameters:
    start - the start date.
    end - the end date.
    
    Returns:
    the duration between start and end.
    
    Throws:
    
    NullPointerException - if one of the arguments is null.
  - since
```
public static Duration since(Date d)
```
    Creates a new Duration instance representing the amount of time elapsed since the given date.
    
    Parameters:
    d - the start date.
    
    Returns:
    the duration since d.
    
    Throws:
    
    NullPointerException - if d is null.
  - until
```
public static Duration until(Date d)
```
    Creates a new Duration instance representing the amount of time that will elapse until the given date.
    
    Parameters:
    d - the end date.
    
    Returns:
    the duration until d.
    
    Throws:
    
    NullPointerException - if d is null.
  - plus
```
public Duration plus(Duration d)
```
    Returns the result of adding the given duration to this duration.
    
    Parameters:
    d - the duration to add.
    
    Returns:
    the sum of this duration and the given one.
    
    Throws:
    
    NullPointerException - if d is null.
    
    ArithmeticException - if the resulting duration is too large.
  - minus
```
public Duration minus(Duration d)
```
    Returns the result of subtracting the given duration from this one.
    
    Parameters:
    d - the duration to subtract.
    
    Returns:
    the difference between this duration and the given one.
    
    Throws:
    
    NullPointerException - if d is null.
    
    ArithmeticException - if the resulting duration is too large.
  - multipliedBy
```
public Duration multipliedBy(int factor)
```
    Returns the result of multiplying this duration by the given factor.
    
    Parameters:
    factor - the multiplication factor.
    
    Returns:
    the product of this duration by the given factor.
    
    Throws:
    
    ArithmeticException - if the resulting duration is too large.
  - dividedBy
```
public Duration dividedBy(int divisor)
```
    Returns the result of dividing this duration by the given divisor.
    
    Parameters:
    divisor - the divisor.
    
    Returns:
    the resulting duration.
    
    Throws:
    
    ArithmeticException - if the resulting duration is too large.
  - sign
```
public int sign()
```
    Returns the sign of this duration, namely it returns 1 if this duration is positive, 0 if it is equal to 0, and -1 if it is negative.
    
    Returns:
    the sign of this duration.
  - negated
```
public Duration negated()
```
    Returns the result of negating this duration.
    
    Returns:
    the negated duration.
    
    Throws:
    
    ArithmeticException - if the resulting duration is too large.
  - absoluteValue
```
public Duration absoluteValue()
```
    Returns a copy of this duration with a positive length.
    
    Returns:
    a copy of this duration with a positive length.
    
    Throws:
    
    ArithmeticException - if the resulting duration is too large.
  - after
```
public Date after(Date d)
```
    Returns the date obtained by adding this duration to the given date.
    
    Parameters:
    d - the origin date.
    
    Returns:
    the date obtained by adding this duration to the given date.
    
    Throws:
    
    ArithmeticException - if the resulting duration is too large.
  - before
```
public Date before(Date d)
```
    Returns the date obtained by subtracting this duration from the given date.
    
    Parameters:
    d - the origin date.
    
    Returns:
    the date obtained by subtracting this duration from the given date.
    
    Throws:
    
    ArithmeticException - if the resulting duration is too large.
  - to
```
public long to(TimeUnit unit)
```
    Converts this duration into the given unit. Beware of possible precision loss.
    
    Parameters:
    unit - the target unit.
    
    Returns:
    the value of the duration in the given unit.
    
    Throws:
    
    NullPointerException - if unit is null.
  - toMilliseconds
```
public long toMilliseconds()
```
    Returns the number of milliseconds in this duration.
    
    Returns:
    the number of milliseconds in this duration.
  - compareTo
```
public int compareTo(Duration d)
```
    Specified by:
    
    compareTo in interface Comparable<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

Class Duration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE_MILLISECOND

ONE_SECOND

ONE_MINUTE

ONE_HOUR

ONE_DAY

ONE_WEEK

Method Detail

parse

of

of

between

since

until

plus

minus

multipliedBy

dividedBy

sign

negated

absoluteValue

after

before

to

toMilliseconds

compareTo

equals

hashCode

toString