org.pfsw.util

Class PointInTime

java.lang.Object

org.pfsw.util.PointInTime

public class PointInTime
extends java.lang.Object

Represents a point in time in milliseconds since midnight, January 1, 1970 UTC.

Constructor Summary

Constructors

Constructor and Description
PointInTime(long epochTimestampInMilliseconds)

Method Summary

Modifier and Type	Method and Description
java.util.Date	asDate() Returns this point in time as date.
static PointInTime	create(java.util.Date date)
static PointInTime	create(long epochTimestampInMilliseconds)
Duration	getDurationUntilReached() Returns the remaining time until the point in time has been reached as duration.
long	getEpochTimestamp() Returns the point in time in milliseconds since midnight, January 1, 1970 UTC.
long	getRemainingTime() Returns the remaining time in milliseconds until this point in time is reached.
boolean	isReached() Returns whether or not this point in time has been reached.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PointInTime

public PointInTime(long epochTimestampInMilliseconds)

Method Detail

create

public static PointInTime create(long epochTimestampInMilliseconds)

create

public static PointInTime create(java.util.Date date)

getEpochTimestamp

public long getEpochTimestamp()

Returns the point in time in milliseconds since midnight, January 1, 1970 UTC.

getRemainingTime

public long getRemainingTime()

Returns the remaining time in milliseconds until this point in time is reached. A value less or equal zero indicates that the point in time has been reached.

getDurationUntilReached

public Duration getDurationUntilReached()

Returns the remaining time until the point in time has been reached as duration. Be aware that the lowest value will be a duration of 0.

isReached

public boolean isReached()

Returns whether or not this point in time has been reached.

asDate

public java.util.Date asDate()

Returns this point in time as date.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object