Package com.qfs.snl.impl

Class TimePeriod

java.lang.Object

com.qfs.snl.impl.TimePeriod

All Implemented Interfaces:

ITimePeriod

public class TimePeriod
extends Object
implements ITimePeriod

Effective implementation of ITimePeriod.

Author:

ActiveViam

Constructor Summary

Constructors

Constructor	Description
TimePeriod()	Default constructor with prescribed time supplier.
TimePeriod(ITimePeriod period)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
boolean	contains(long time)	Decides if a time is strictly contained by the period.
boolean	equals(Object obj)
TimePeriod	from(long time)	Adds a start boundary.
TimePeriod	fromNow()	Adds a start boundary using server current time.
long	getCurrentTime()	Gets the resolved current time.
long	getFromTime()	Gets the resolved 'from' timestamp.
long	getToTime()	Gets the resolved 'to' timestamp.
boolean	hasFromTime()	Gets if the period has a start boundary.
int	hashCode()
boolean	hasToTime()	Gets if the period has an end boundary.
boolean	isFromNow()	Gets if the 'from' boundary is made of the server current time.
boolean	isToNow()	Gets if the 'to' boundary is made of the server current time.
void	resolve(ITimeSupplier clock)	Resolves the current time for boundaries.
TimePeriod	to(long time)	Adds an end boundary to the time period.
TimePeriod	toNow()	Adds an end boundary to the period using server current time.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.qfs.snl.ITimePeriod

equals, hashCode

Constructor Details

TimePeriod

public TimePeriod()

Default constructor with prescribed time supplier.

This creates a time period without boundaries.

TimePeriod

public TimePeriod(ITimePeriod period)

Copy constructor.

Parameters:

period - period to copy

Method Details

from

public TimePeriod from(long time)

Adds a start boundary.

Parameters:

time - timestamp in ms

Returns:

this

fromNow

public TimePeriod fromNow()

Adds a start boundary using server current time.

Returns:

this

to

public TimePeriod to(long time)

Adds an end boundary to the time period.

Parameters:

time - timestamp in ms

Returns:

this

toNow

public TimePeriod toNow()

Adds an end boundary to the period using server current time.

Returns:

this

resolve

public void resolve(ITimeSupplier clock)

Description copied from interface: ITimePeriod

Resolves the current time for boundaries.

Specified by:

resolve in interface ITimePeriod

Parameters:

clock - the time supplier with respect to which the time period need be resolved

hasFromTime

public boolean hasFromTime()

Description copied from interface: ITimePeriod

Gets if the period has a start boundary.

Specified by:

hasFromTime in interface ITimePeriod

Returns:

true if a 'from' value is defined

getFromTime

public long getFromTime()

Description copied from interface: ITimePeriod

Gets the resolved 'from' timestamp.

Specified by:

getFromTime in interface ITimePeriod

Returns:

boundary as a UNIX timestamp in ms

isFromNow

public boolean isFromNow()

Description copied from interface: ITimePeriod

Gets if the 'from' boundary is made of the server current time.

Specified by:

isFromNow in interface ITimePeriod

Returns:

true if the boundary is dynamic, false otherwise

hasToTime

public boolean hasToTime()

Description copied from interface: ITimePeriod

Gets if the period has an end boundary.

Specified by:

hasToTime in interface ITimePeriod

Returns:

true if a 'to' value is defined

getToTime

public long getToTime()

Description copied from interface: ITimePeriod

Gets the resolved 'to' timestamp.

Specified by:

getToTime in interface ITimePeriod

Returns:

boundary as a UNIX timestamp in ms

isToNow

public boolean isToNow()

Description copied from interface: ITimePeriod

Gets if the 'to' boundary is made of the server current time.

Specified by:

isToNow in interface ITimePeriod

Returns:

true if the boundary is dynamic, false otherwise

getCurrentTime

public long getCurrentTime()

Description copied from interface: ITimePeriod

Gets the resolved current time.

Specified by:

getCurrentTime in interface ITimePeriod

Returns:

the current time.

contains

public boolean contains(long time)

Description copied from interface: ITimePeriod

Decides if a time is strictly contained by the period.

Specified by:

contains in interface ITimePeriod

Parameters:

time - timestamp in ms

Returns:

true if the period contains the time.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object