org.rvpf.base

Class ElapsedTime

Object

ElapsedTime

All Implemented Interfaces:

Serializable, Comparable<ElapsedTime>

@Immutable
public final class ElapsedTime
extends Object
implements Serializable, Comparable<ElapsedTime>

Elapsed time.

Implements elapsed time using the same time unit as DateTime: an integer number of 100 nanoseconds.

An elapsed time is immutable and never negative.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ElapsedTime	EMPTY Empty.
static ElapsedTime	HOUR One hour.
static ElapsedTime	INFINITY Infinity.
static String	INFINITY_STRING Infinity string representation.
static ElapsedTime	INVALID Invalid elsped time representation.
static ElapsedTime	MICRO One microsecond.
static ElapsedTime	MILLI One millisecond.
static ElapsedTime	MINUTE One minute.
static ElapsedTime	SECOND One second.

Method Summary

Modifier and Type	Method and Description
ElapsedTime	add(ElapsedTime other) Adds an other elapsed time to this.
int	compareTo(ElapsedTime other)
boolean	equals(Object other)
ElapsedTime	floor(ElapsedTime whole) Floors the scaled internal (raw) representation of this.
ElapsedTime	floor(long whole) Floors the scaled internal (raw) representation of this.
static ElapsedTime	fromDataInput(DataInput source) Reads in an external representation of an elapsed time.
static ElapsedTime	fromDuration(Duration duration) Returns an elapsed time from a duration.
static ElapsedTime	fromMillis(long millis) Returns an elapsed time from a number of milliseconds.
static ElapsedTime	fromNanos(long nanos) Returns an elapsed time from a number of nanoseconds.
static ElapsedTime	fromRaw(long raw) Returns an elapsed time from an internal (raw) representation.
static ElapsedTime	fromSeconds(double seconds) Returns an elapsed time from a number of seconds.
static Optional<ElapsedTime>	fromString(Optional<String> string) Returns an elapsed time from an optional string representation.
static ElapsedTime	fromString(String elapsedString) Returns an elapsed time from a valid string representation.
int	hashCode()
boolean	isEmpty() Asks if this is an empty interval.
boolean	isInfinity() Asks if this is infinity.
boolean	isInvalid() Asks if this is the invalid elapsed time.
static ElapsedTime	max(Collection<ElapsedTime> elapsedTimes) Returns the maximum ElapsedTime instance.
static ElapsedTime	max(ElapsedTime... elapsedTimes) Returns the maximum ElapsedTime instance.
ElapsedTime	max(Optional<ElapsedTime> other) Returns the maximum between this and an other.
static ElapsedTime	min(Collection<ElapsedTime> elapsedTimes) Returns the minimum ElapsedTime instance.
static ElapsedTime	min(ElapsedTime... elapsedTimes) Returns the minimum ElapsedTime instance.
ElapsedTime	min(Optional<ElapsedTime> other) Returns the minimum between this and an other.
ElapsedTime	mul(double factor) Multiplies this by a factor.
ElapsedTime	mul(long factor) Multiplies this by a factor.
double	ratio(ElapsedTime divisor) Returns the ratio of this to an other elapsed time.
static Optional<ElapsedTime>	readExternal(ObjectInput source) Reads in an external representation of an elapsed time.
double	scaled(ElapsedTime whole) Returns the scaled internal (raw) representation of this.
double	scaled(long whole) Returns the scaled internal (raw) representation of this.
ElapsedTime	sub(ElapsedTime other) Substracts an other elapsed time from this.
void	toDataOutput(DataOutput destination) Sends to a data output.
Duration	toDuration() Returns a duration.
String	toDurationString() Returns this as a duration string.
long	toMillis() Returns this in millis.
long	toRaw() Returns the internal (raw) representation of this.
double	toSeconds() Returns this in seconds.
String	toString()
static void	writeExternal(Optional<ElapsedTime> elapsedTime, ObjectOutput destination) Writes out an external representation of an elapsed time.

Methods inherited from class Object

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

Field Detail

EMPTY

public static final ElapsedTime EMPTY

Empty.

HOUR

public static final ElapsedTime HOUR

One hour.

INFINITY

public static final ElapsedTime INFINITY

Infinity.

INFINITY_STRING

public static final String INFINITY_STRING

Infinity string representation.

See Also:

Constant Field Values

INVALID

public static final ElapsedTime INVALID

Invalid elsped time representation.

MICRO

public static final ElapsedTime MICRO

One microsecond.

MILLI

public static final ElapsedTime MILLI

One millisecond.

MINUTE

public static final ElapsedTime MINUTE

One minute.

SECOND

public static final ElapsedTime SECOND

One second.

Method Detail

fromDataInput

@Nonnull
 @CheckReturnValue
public static ElapsedTime fromDataInput(@Nonnull
                                                                      DataInput source)
                                                               throws IOException

Reads in an external representation of an elapsed time.

Parameters:

source - The source.

Returns:

The elapsed time (may be INVALID).

Throws:

IOException - When an I/O error occurs.

fromDuration

@Nonnull
 @CheckReturnValue
public static ElapsedTime fromDuration(Duration duration)

Returns an elapsed time from a duration.

Parameters:

duration - The duration.

Returns:

The elapsed time.

fromMillis

@Nonnull
 @CheckReturnValue
public static ElapsedTime fromMillis(long millis)

Returns an elapsed time from a number of milliseconds.

Parameters:

millis - The number of milliseconds.

Returns:

The elapsed time.

fromNanos

@Nonnull
 @CheckReturnValue
public static ElapsedTime fromNanos(long nanos)

Returns an elapsed time from a number of nanoseconds.

Parameters:

nanos - The number of nanoseconds.

Returns:

The elapsed time.

fromRaw

@Nonnull
 @CheckReturnValue
public static ElapsedTime fromRaw(long raw)

Returns an elapsed time from an internal (raw) representation.

Parameters:

raw - The internal (raw) representation.

Returns:

The elapsed time.

fromSeconds

@Nonnull
 @CheckReturnValue
public static ElapsedTime fromSeconds(double seconds)

Returns an elapsed time from a number of seconds.

Parameters:

seconds - The number of seconds.

Returns:

The elapsed time.

fromString

@Nonnull
 @CheckReturnValue
public static Optional<ElapsedTime> fromString(@Nonnull
                                                                             Optional<String> string)

Returns an elapsed time from an optional string representation.

A null or empty string will return null.

Parameters:

string - The optional string representation.

Returns:

The optional elapsed time or empty.

fromString

@Nonnull
 @CheckReturnValue
public static ElapsedTime fromString(@Nonnull
                                                                   String elapsedString)

Returns an elapsed time from a valid string representation.

Parameters:

elapsedString - The string representation.

Returns:

The elapsed time.

max

@Nonnull
 @CheckReturnValue
public static ElapsedTime max(@Nonnull
                                                            Collection<ElapsedTime> elapsedTimes)

Returns the maximum ElapsedTime instance.

Note: a null value is considered infinite.

Parameters:

elapsedTimes - The ElapsedTime instances.

Returns:

The maximum ElapsedTime instance.

max

@Nonnull
 @CheckReturnValue
public static ElapsedTime max(@Nonnull
                                                            ElapsedTime... elapsedTimes)

Returns the maximum ElapsedTime instance.

Note: a null value is considered infinite.

Parameters:

elapsedTimes - The ElapsedTime instances.

Returns:

The maximum ElapsedTime instance.

min

@Nonnull
 @CheckReturnValue
public static ElapsedTime min(@Nonnull
                                                            Collection<ElapsedTime> elapsedTimes)

Returns the minimum ElapsedTime instance.

Note: a null value is considered infinite.

Parameters:

elapsedTimes - The ElapsedTime instances.

Returns:

The minimum ElapsedTime instance.

min

@Nonnull
 @CheckReturnValue
public static ElapsedTime min(@Nonnull
                                                            ElapsedTime... elapsedTimes)

Returns the minimum ElapsedTime instance.

Note: a null value is considered infinite.

Parameters:

elapsedTimes - The ElapsedTime instances.

Returns:

The minimum ElapsedTime instance.

readExternal

@Nonnull
 @CheckReturnValue
public static Optional<ElapsedTime> readExternal(@Nonnull
                                                                               ObjectInput source)
                                                                        throws IOException

Reads in an external representation of an elapsed time.

This is a helper method for Externalizable objects containing an ElapsedTime.

Parameters:

source - The source.

Returns:

The elapsed time or empty.

Throws:

IOException - When an I/O error occurs.

writeExternal

public static void writeExternal(@Nonnull
                                 Optional<ElapsedTime> elapsedTime,
                                 @Nonnull
                                 ObjectOutput destination)
                          throws IOException

Writes out an external representation of an elapsed time.

This is a helper method for Externalizable objects containing an ElapsedTime.

Parameters:

elapsedTime - The elapsed time (may be empty).

destination - The destination.

Throws:

IOException - When an I/O error occurs.

add

@Nonnull
 @CheckReturnValue
public ElapsedTime add(@Nonnull
                                                     ElapsedTime other)

Adds an other elapsed time to this.

Parameters:

other - The other elapsed time.

Returns:

The combined elapsed time.

compareTo

public int compareTo(@Nonnull
                     ElapsedTime other)

Specified by:

compareTo in interface Comparable<ElapsedTime>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

floor

@Nonnull
 @CheckReturnValue
public ElapsedTime floor(@Nonnull
                                                       ElapsedTime whole)

Floors the scaled internal (raw) representation of this.

Parameters:

whole - An elapsed time representing a whole value.

Returns:

The scaled value.

floor

@Nonnull
 @CheckReturnValue
public ElapsedTime floor(long whole)

Floors the scaled internal (raw) representation of this.

Parameters:

whole - The number of 100 nanoseconds representing a whole value.

Returns:

The scaled value.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

@CheckReturnValue
public boolean isEmpty()

Asks if this is an empty interval.

Returns:

A true if this interval is empty.

isInfinity

@CheckReturnValue
public boolean isInfinity()

Asks if this is infinity.

Returns:

A true value if this is infinity.

isInvalid

@CheckReturnValue
public boolean isInvalid()

Asks if this is the invalid elapsed time.

Returns:

True if this is the invalid elapsed time.

max

@Nonnull
 @CheckReturnValue
public ElapsedTime max(@Nonnull
                                                     Optional<ElapsedTime> other)

Returns the maximum between this and an other.

Note: an empty value is considered infinite.

Parameters:

other - The other.

Returns:

The maximum elapsed time.

min

@Nonnull
 @CheckReturnValue
public ElapsedTime min(@Nonnull
                                                     Optional<ElapsedTime> other)

Returns the minimum between this and an other.

Note: an empty value is considered infinite.

Parameters:

other - The other.

Returns:

The minimum elapsed time.

mul

@Nonnull
 @CheckReturnValue
public ElapsedTime mul(double factor)

Multiplies this by a factor.

Parameters:

factor - The factor.

Returns:

The resulting elapsed time.

mul

@Nonnull
 @CheckReturnValue
public ElapsedTime mul(long factor)

Multiplies this by a factor.

Parameters:

factor - The factor.

Returns:

The resulting elapsed time.

ratio

@CheckReturnValue
public double ratio(@Nonnull
                                       ElapsedTime divisor)

Returns the ratio of this to an other elapsed time.

Parameters:

divisor - The other elapsed time.

Returns:

The ratio.

scaled

@CheckReturnValue
public double scaled(@Nonnull
                                        ElapsedTime whole)

Returns the scaled internal (raw) representation of this.

Parameters:

whole - An elapsed time representing a whole value.

Returns:

The scaled value.

scaled

@CheckReturnValue
public double scaled(long whole)

Returns the scaled internal (raw) representation of this.

Parameters:

whole - The number of 100 nanoseconds representing a whole value.

Returns:

The scaled value.

sub

@Nonnull
 @CheckReturnValue
public ElapsedTime sub(@Nonnull
                                                     ElapsedTime other)

Substracts an other elapsed time from this.

Subtracting from infinity always results in infinity.

Subtracting infinity from non infinity always results in none.

The substraction results in the absolute value of the time difference.

Parameters:

other - The other elapsed time.

Returns:

The elapsed times difference.

toDataOutput

public void toDataOutput(@Nonnull
                         DataOutput destination)
                  throws IOException

Sends to a data output.

Parameters:

destination - The destination.

Throws:

IOException - On I/O exception.

toDuration

@Nonnull
 @CheckReturnValue
public Duration toDuration()

Returns a duration.

Returns:

The duration.

toDurationString

@Nonnull
 @CheckReturnValue
public String toDurationString()

Returns this as a duration string.

Returns:

This as a duration string.

toMillis

@Nonnegative
 @CheckReturnValue
public long toMillis()

Returns this in millis.

Returns:

This in millis.

toRaw

@Nonnegative
 @CheckReturnValue
public long toRaw()

Returns the internal (raw) representation of this.

Returns:

A number of 100 nanoseconds.

toSeconds

@Nonnegative
 @CheckReturnValue
public double toSeconds()

Returns this in seconds.

Returns:

This in seconds.

toString

public String toString()

Overrides:

toString in class Object