Duration (POJava DateTime 3.0.0 API)

java.lang.Object
- org.pojava.datetime.Duration

All Implemented Interfaces:

Serializable, Comparable<Duration>
```
public class Duration
extends Object
implements Comparable<Duration>, Serializable
```
Duration is a fixed measurement of time.

Author:

John Pile

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DAY` A DAY = 24 hours (for a variable day, see CalendarUnit)
`static long`	`HOUR` An HOUR = 60 minutes
`protected long`	`millis` Non-leap Milliseconds since an epoch
`static long`	`MILLISECOND` A MILLISECOND = one thousandth of a second
`static long`	`MINUTE` A MINUTE = 60 seconds
`protected int`	`nanos` Nanoseconds used by high-resolution time stamps
`static long`	`SECOND` A SECOND = One second is the time that elapses during 9,192,631,770 cycles of the radiation produced by the transition between two levels of the cesium 133 atom...
`static long`	`WEEK` A WEEK = a fixed set of seven 24-hour days

Constructor Summary

Constructors
Constructor and Description
`Duration()` Constructor for a duration of zero.
`Duration(long millis)` Duration specified in milliseconds.
`Duration(long seconds, int nanos)` Seconds + nanos pair will always be adjusted so that nanos is positive.
`Duration(String duration)` Constructor parsing from a string.

Method Summary

Methods
Modifier and Type	Method and Description
`Duration`	`add(Duration dur)` Add a duration, producing a new duration.
`Duration`	`add(long milliseconds)` Add fixed number of (+/-) milliseconds to a Duration, producing a new Duration.
`Duration`	`add(long seconds, int nanos)` Add seconds and nanoseconds to a Duration, producing a new Duration.
`int`	`compareTo(Duration other)` Return relative comparison between two Durations.
`boolean`	`equals(Object other)` Two durations are equal if internal values are identical.
`int`	`getNanos()` Return fractional seconds in nanoseconds Sign of value will match whole time value.
`long`	`getSeconds()` Return duration truncated seconds.
`int`	`hashCode()`
`static Duration`	`parse(String str)` Return a duration parsed from a string.
`long`	`toMillis()` Return time truncated to milliseconds
`String`	`toString()` Output duration as a string.

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

- Field Detail
  - MILLISECOND
```
public static final long MILLISECOND
```
    A MILLISECOND = one thousandth of a second
    
    See Also:
    Constant Field Values
  - SECOND
```
public static final long SECOND
```
    A SECOND = One second is the time that elapses during 9,192,631,770 cycles of the radiation produced by the transition between two levels of the cesium 133 atom... rounded to some margin of error by your less accurate system clock.
    
    See Also:
    Constant Field Values
  - MINUTE
```
public static final long MINUTE
```
    A MINUTE = 60 seconds
    
    See Also:
    Constant Field Values
  - HOUR
```
public static final long HOUR
```
    An HOUR = 60 minutes
    
    See Also:
    Constant Field Values
  - DAY
```
public static final long DAY
```
    A DAY = 24 hours (for a variable day, see CalendarUnit)
    
    See Also:
    Constant Field Values
  - WEEK
```
public static final long WEEK
```
    A WEEK = a fixed set of seven 24-hour days
    
    See Also:
    Constant Field Values
  - millis
```
protected long millis
```
    Non-leap Milliseconds since an epoch
  - nanos
```
protected int nanos
```
    Nanoseconds used by high-resolution time stamps
- Constructor Detail
  - Duration
```
public Duration()
```
    Constructor for a duration of zero.
  - Duration
```
public Duration(String duration)
```
    Constructor parsing from a string.
    
    Parameters:
    duration - String representation of a duration.
  - Duration
```
public Duration(long millis)
```
    Duration specified in milliseconds.
    
    Parameters:
    millis -
  - Duration
```
public Duration(long seconds,
        int nanos)
```
    Seconds + nanos pair will always be adjusted so that nanos is positive. It's a strange arrangement, but useful when representing time as an offset of Epoch, where a negative value usually represents a positive year.
    
    Parameters:
    seconds -
    nanos -
- Method Detail
  - add
```
public Duration add(Duration dur)
```
    Add a duration, producing a new duration.
    
    Parameters:
    dur -
    
    Returns:
    A newly calculated Duration.
  - add
```
public Duration add(long milliseconds)
```
    Add fixed number of (+/-) milliseconds to a Duration, producing a new Duration.
    
    Parameters:
    milliseconds -
    
    Returns:
    A newly calculated Duration.
  - add
```
public Duration add(long seconds,
           int nanos)
```
    Add seconds and nanoseconds to a Duration, producing a new Duration.
    
    Parameters:
    seconds -
    nanos -
    
    Returns:
    A newly calculated Duration.
  - compareTo
```
public int compareTo(Duration other)
```
    Return relative comparison between two Durations.
    
    Specified by:
    
    compareTo in interface Comparable<Duration>
    
    Parameters:
    other - Duration to compare to
    
    Returns:
    -1, 0, or 1 of left compared to right.
  - equals
```
public boolean equals(Object other)
```
    Two durations are equal if internal values are identical.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other - is a Duration or derived object
    
    Returns:
    True if durations match.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getNanos
```
public int getNanos()
```
    Return fractional seconds in nanoseconds
    Sign of value will match whole time value.
    
    Returns:
    Sub-second portion of Duration specified in nanoseconds.
  - toMillis
```
public long toMillis()
```
    Return time truncated to milliseconds
    
    Returns:
    Number of whole milliseconds in Duration.
  - getSeconds
```
public long getSeconds()
```
    Return duration truncated seconds.
    
    Returns:
    Number of whole seconds in Duration.
  - parse
```
public static Duration parse(String str)
```
    Return a duration parsed from a string. Expected string is of regex format "(-?[0-9]*\.?[0-9]+ *['"wdhmsnWDHMSN][^-0-9.]*)+"
    
    Parameters:
    str - of format similar to "1h15m12s" or "8 weeks, 3.5 days" or [5'13"]
    
    Returns:
    a new Duration object
  - toString
```
public String toString()
```
    Output duration as a string.
    
    Overrides:
    
    toString in class Object

Class Duration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MILLISECOND

SECOND

MINUTE

HOUR

DAY

WEEK

millis

nanos

Constructor Detail

Duration

Duration

Duration

Duration

Method Detail

add

add

add

compareTo

equals

hashCode

getNanos

toMillis

getSeconds

parse

toString