com.mulesoft.mule.runtime.gw.api.time.period

Class Period

java.lang.Object

com.mulesoft.mule.runtime.gw.api.time.period.Period

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MillisPeriod, SecondsPeriod

public abstract class Period
extends Object
implements Serializable

This object represent a period of time.

Each Period define it's duration time in milliseconds. Also, it knows a clock with the current time, useful when defining calendar periods.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Period()

Method Summary

Modifier and Type	Method and Description
abstract long	inMillis()
long	inSeconds()
static Period	millis(long period)
static Period	seconds(int seconds)
static Period	seconds(long seconds)
abstract void	updateWith(Clock clock) Period duration can be dependant to the current clock, therefore one can be set.

Methods inherited from class java.lang.Object

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

Constructor Detail

Period

public Period()

Method Detail

updateWith

public abstract void updateWith(Clock clock)

Period duration can be dependant to the current clock, therefore one can be set.

Parameters:

clock - Clock.

inMillis

public abstract long inMillis()

Returns:

Time duration of the period in milliseconds

inSeconds

public long inSeconds()

Returns:

Time duration of the period in seconds, value will be rounded if it's not integer.

millis

public static Period millis(long period)

seconds

public static Period seconds(int seconds)

seconds

public static Period seconds(long seconds)