com.mulesoft.mule.runtime.gw.internal.time.frame

Class FixedTimeFrame

java.lang.Object

com.mulesoft.mule.runtime.gw.internal.time.frame.FixedTimeFrame

All Implemented Interfaces:

TimeFrame, Serializable

public class FixedTimeFrame
extends Object
implements TimeFrame

Defines a fixed time frame.

Knows his bounds, a given a clock knows if it is current and who is the next valid TimeFrame (could be itself if frame is still current).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FixedTimeFrame(Clock clock, DateTime startTime, Period period)

Method Summary

Modifier and Type	Method and Description
boolean	contains(DateTime dateTime)
boolean	equals(Object anotherObject)
boolean	hasFinished() Checks that the current time is in the current time frame.
long	inMillis()
protected boolean	inRange(DateTime time)
long	millisUntilNextTimeFrame()
TimeFrame	next()
DateTime	startTime()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedTimeFrame

public FixedTimeFrame(Clock clock,
                      DateTime startTime,
                      Period period)

Method Detail

hasFinished

public boolean hasFinished()

Description copied from interface: TimeFrame

Checks that the current time is in the current time frame.

Specified by:

hasFinished in interface TimeFrame

Returns:

true if the current time is inside the time frame windows, false otherwise.

inRange

protected boolean inRange(DateTime time)

millisUntilNextTimeFrame

public long millisUntilNextTimeFrame()

Specified by:

millisUntilNextTimeFrame in interface TimeFrame

Returns:

time in milliseconds until the next time frame starts.

inMillis

public long inMillis()

Specified by:

inMillis in interface TimeFrame

Returns:

time in milliseconds of the whole frame.

next

public TimeFrame next()

Specified by:

next in interface TimeFrame

Returns:

TimeFrame that contains the current time. If this instance contains the current time, then it should return itself.

startTime

public DateTime startTime()

Specified by:

startTime in interface TimeFrame

Returns:

frame start time.

contains

public boolean contains(DateTime dateTime)

Specified by:

contains in interface TimeFrame

Parameters:

dateTime - the instant to check

Returns:

whether the specified time is within the time frame

equals

public boolean equals(Object anotherObject)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object