com.aoindustries.time

Class Instant

java.lang.Object

com.aoindustries.time.Instant

All Implemented Interfaces:

ObjectInputValidation, Serializable, Comparable<Instant>

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

Wraps the number of seconds from the Epoch 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 Instant	EPOCH

Constructor Summary

Constructors

Constructor and Description
Instant(long epochSecond, int nano)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Instant other)
boolean	equals(Instant other)
boolean	equals(Object obj)
long	getEpochSecond()
int	getNano() The nanoseconds, to simplify this is always in the positive direction.
int	hashCode()
Instant	plusNanos(long nanosToAdd)
String	toString()
void	validateObject()
static Instant	valueOf(String s) Parses an Instant's string representation.

Methods inherited from class java.lang.Object

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

Field Detail

EPOCH

public static final Instant EPOCH

Constructor Detail

Instant

public Instant(long epochSecond,
               int nano)

Method Detail

valueOf

public static Instant valueOf(String s)

Parses an Instant's string representation.

Returns:

Instant the instant or null when toString is null

Throws:

IllegalArgumentException - when unable to parse

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(Instant other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Instant other)

Specified by:

compareTo in interface Comparable<Instant>

getEpochSecond

public long getEpochSecond()

getNano

public int getNano()

The nanoseconds, to simplify this is always in the positive direction. For negative instants, 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

plusNanos

public Instant plusNanos(long nanosToAdd)