com.aoindustries.time

Class Duration

java.lang.Object

com.aoindustries.time.Duration

All Implemented Interfaces:

ObjectInputValidation, Serializable, Comparable<Duration>

public class Duration
extends Object
implements Comparable<Duration>, Serializable, ObjectInputValidation

Wraps a duration as the number of seconds as well as positive nanoseconds into an immutable value type.

This will be deprecated once Java 8 is ubiquitous and only serves as an extremely simplified stop-gap.

Author:

AO Industries, Inc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Duration	ZERO

Constructor Summary

Constructors

Constructor and Description
Duration(long seconds, int nano)

Method Summary

Modifier and Type	Method and Description
static Duration	between(Instant startInclusive, Instant endExclusive)
int	compareTo(Duration other)
boolean	equals(Duration other)
boolean	equals(Object obj)
int	getNano() The nanoseconds, to simplify this is always in the positive direction.
long	getSeconds()
int	hashCode()
long	toNanos() Gets this duration as a number of nanoseconds only.
String	toString()
void	validateObject()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final Duration ZERO

Constructor Detail

Duration

public Duration(long seconds,
                int nano)

Method Detail

between

public static Duration between(Instant startInclusive,
                               Instant endExclusive)

validateObject

public void validateObject()
                    throws InvalidObjectException

Specified by:

validateObject in interface ObjectInputValidation

Throws:

InvalidObjectException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public boolean equals(Duration other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Duration other)

Specified by:

compareTo in interface Comparable<Duration>

getSeconds

public long getSeconds()

getNano

public int getNano()

The nanoseconds, to simplify this is always in the positive direction. For negative durations, this means the nanos goes up from zero to 1 billion, then the seconds go up one (toward zero). This may be counterintuitive if one things of nanoseconds as a fractional part of seconds, but this definition leads to a very clean implementation.

Counting up by nanoseconds:

1. -1.999999998
2. -1.999999999
3. 0.000000000
4. 0.000000001
5. 0.000000002

toNanos

public long toNanos()
             throws ArithmeticException

Gets this duration as a number of nanoseconds only. This covers a range around -292 years to +292 years.

Throws:

ArithmeticException - if duration is outside the range representable in nanoseconds