javax.cache.expiry

Class Duration

java.lang.Object

javax.cache.expiry.Duration

All Implemented Interfaces:

Serializable

public class Duration
extends Object
implements Serializable

A Serializable duration of time.

Since:

1.0

Author:

Yannis Cosmadopoulos, Greg Luck, Brian Oliver

See Also:

ExpiryPolicy, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Duration	ETERNAL ETERNAL (forever).
static Duration	FIVE_MINUTES Five minutes.
static Duration	ONE_DAY One day.
static Duration	ONE_HOUR One hour.
static Duration	ONE_MINUTE One minute.
static long	serialVersionUID The serialVersionUID required for Serializable.
static Duration	TEN_MINUTES Ten minutes.
static Duration	THIRTY_MINUTES Thirty minutes.
static Duration	TWENTY_MINUTES Twenty minutes.
static Duration	ZERO Zero (no time).

Constructor Summary

Constructors

Constructor and Description
Duration() Constructs a Duration (that by default is Eternal).
Duration(long startTime, long endTime) Constructs a Duration based on the duration between two specified points in time (since the Epoc), measured in milliseconds.
Duration(TimeUnit timeUnit, long durationAmount) Constructs a duration.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
long	getAdjustedTime(long time) Calculates the adjusted time (from the Epoc) given a specified time (to be adjusted) by the duration.
long	getDurationAmount() Obtain the number of TimeUnits in the Duration
TimeUnit	getTimeUnit() Obtain the TimeUnit for the Duration
int	hashCode()
boolean	isEternal() Determines if a Duration is eternal (forever).
boolean	isZero() Determines if a Duration is zero.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

The serialVersionUID required for Serializable.

See Also:

Constant Field Values

ETERNAL

public static final Duration ETERNAL

ETERNAL (forever).

ONE_DAY

public static final Duration ONE_DAY

One day.

ONE_HOUR

public static final Duration ONE_HOUR

One hour.

THIRTY_MINUTES

public static final Duration THIRTY_MINUTES

Thirty minutes.

TWENTY_MINUTES

public static final Duration TWENTY_MINUTES

Twenty minutes.

TEN_MINUTES

public static final Duration TEN_MINUTES

Ten minutes.

FIVE_MINUTES

public static final Duration FIVE_MINUTES

Five minutes.

ONE_MINUTE

public static final Duration ONE_MINUTE

One minute.

ZERO

public static final Duration ZERO

Zero (no time).

Constructor Detail

Duration

public Duration()

Constructs a Duration (that by default is Eternal).

Duration

public Duration(TimeUnit timeUnit,
        long durationAmount)

Constructs a duration.

Parameters:

timeUnit - the unit of time to specify time in. The minimum time unit is milliseconds.

durationAmount - how long, in the specified units, the cache entries should live. 0 means eternal.

Throws:

NullPointerException - if timeUnit is null

IllegalArgumentException - if durationAmount is less than 0 or a TimeUnit less than milliseconds is specified

Duration

public Duration(long startTime,
        long endTime)

Constructs a Duration based on the duration between two specified points in time (since the Epoc), measured in milliseconds.

Parameters:

startTime - the start time (since the Epoc)

endTime - the end time (since the Epoc)

Method Detail

getTimeUnit

public TimeUnit getTimeUnit()

Obtain the TimeUnit for the Duration

Returns:

the TimeUnit

getDurationAmount

public long getDurationAmount()

Obtain the number of TimeUnits in the Duration

Returns:

the number of TimeUnits

isEternal

public boolean isEternal()

Determines if a Duration is eternal (forever).

Returns:

true if the Duration is eternal

isZero

public boolean isZero()

Determines if a Duration is zero.

Returns:

true if the Duration is zero

getAdjustedTime

public long getAdjustedTime(long time)

Calculates the adjusted time (from the Epoc) given a specified time (to be adjusted) by the duration.

Parameters:

time - the time from which to adjust given the duration

Returns:

the adjusted time

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object