Package com.globalmentor.time

Class Duration

java.lang.Object

com.globalmentor.time.Duration

All Implemented Interfaces:

java.lang.Comparable<Duration>

public class Duration
extends java.lang.Object
implements java.lang.Comparable<Duration>

Indicates a duration of time in milliseconds. Negative durations are allowed.

Author:

Garret Wilson

Field Summary

Fields

Modifier and Type	Field	Description
static Duration	MAX_DURATION	The shared duration instance indicating the max possible duration.
static Duration	NO_DURATION	The shared duration instance indicating a zero duration.

Method Summary

Modifier and Type	Method	Description
Duration	add(Duration duration)	Adds a duration to this duration.
int	compareTo(Duration duration)
boolean	equals(java.lang.Object object)
long	getTime()
int	hashCode()
static Duration	of(long time)	Duration time factory.
Duration	subtract(Duration duration)	Subtracts a duration from this duration.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_DURATION

public static final Duration NO_DURATION

The shared duration instance indicating a zero duration.

MAX_DURATION

public static final Duration MAX_DURATION

The shared duration instance indicating the max possible duration.

Method Detail

getTime

public long getTime()

Returns:

The duration time in milliseconds.

of

public static Duration of(long time)

Duration time factory.

Parameters:

time - The duration time in milliseconds.

Returns:

A duration representing the given time.

add

public Duration add(Duration duration)

Adds a duration to this duration.

Parameters:

duration - The duration to add.

Returns:

A duration object representing this duration plus the given duration.

Throws:

java.lang.NullPointerException - if the given duration is null.

subtract

public Duration subtract(Duration duration)

Subtracts a duration from this duration.

Parameters:

duration - The duration to subtract.

Returns:

A duration object representing this duration minus the given duration.

Throws:

java.lang.NullPointerException - if the given duration is null.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(Duration duration)

Specified by:

compareTo in interface java.lang.Comparable<Duration>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object