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

Interface TimeFrame

All Superinterfaces:

Serializable

All Known Implementing Classes:

FixedTimeFrame

public interface TimeFrame
extends Serializable

Defines a window of time.

It knows if it is current, and when ask 'next()' returns the frame where current time fits in.

Method Summary

Modifier and Type	Method and Description
boolean	contains(DateTime dateTime)
boolean	hasFinished() Checks that the current time is in the current time frame.
long	inMillis()
long	millisUntilNextTimeFrame()
TimeFrame	next()
DateTime	startTime()

Method Detail

hasFinished

boolean hasFinished()

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

Returns:

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

millisUntilNextTimeFrame

long millisUntilNextTimeFrame()

Returns:

time in milliseconds until the next time frame starts.

inMillis

long inMillis()

Returns:

time in milliseconds of the whole frame.

next

TimeFrame next()

Returns:

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

startTime

DateTime startTime()

Returns:

frame start time.

contains

boolean contains(DateTime dateTime)

Parameters:

dateTime - the instant to check

Returns:

whether the specified time is within the time frame