org.dhatim.businesshours

Class BusinessPeriod

java.lang.Object

org.dhatim.businesshours.BusinessPeriod

public class BusinessPeriod
extends Object

A continous period of business opening.

Author:

Maxime Suret

Constructor Summary

Constructors

Constructor and Description
BusinessPeriod(BusinessTemporal start, BusinessTemporal end) Builds a new instance of BusinessPeriod.

Method Summary

Modifier and Type	Method and Description
boolean	alwaysOpen() Tells if this period is always open.
boolean	equals(Object obj) Tells if this business period is equals to the given one.
BusinessTemporal	getEnd() Get the closing time of this period.
CronExpression	getEndCron() Get a CronExpression that triggers at each period closing.
BusinessTemporal	getStart() Get the opening time of this period.
CronExpression	getStartCron() Get a CronExpression that triggers at each period opening.
int	hashCode()
boolean	isInPeriod(Temporal temporal) Tells if the given temporal lies within this period.
static Set<BusinessPeriod>	merge(Collection<BusinessPeriod> periods) Merge intersecting or adjacent periods.
long	timeBeforeOpening(Temporal temporal, ChronoUnit unit) Gives the amount of time between the given temporal and the next opening of this period.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessPeriod

public BusinessPeriod(BusinessTemporal start,
                      BusinessTemporal end)

Builds a new instance of BusinessPeriod.

Parameters:

start - when the period opens

end - when the period closes

Method Detail

alwaysOpen

public boolean alwaysOpen()

Tells if this period is always open.

Returns:

true if the business is always open, false otherwise

isInPeriod

public boolean isInPeriod(Temporal temporal)

Tells if the given temporal lies within this period.

Parameters:

temporal - the temporal

Returns:

true if the temporal is included in this period, false otherwise.

timeBeforeOpening

public long timeBeforeOpening(Temporal temporal,
                              ChronoUnit unit)

Gives the amount of time between the given temporal and the next opening of this period.

Parameters:

temporal - the temporal

unit - the unit in which the result must be given

Returns:

Long.MAX_VALUE if the business is always open, else the amount of time expressed in unit.

getStartCron

public CronExpression getStartCron()

Get a CronExpression that triggers at each period opening. e.g. if the period is 9am-18pm, the result will be 0 9 * * *

Returns:

null if the period is always open, else the cron expression

getEndCron

public CronExpression getEndCron()

Get a CronExpression that triggers at each period closing. e.g. if the period is 9am-18pm, the result will be 59 18 * * *

Returns:

null if the period is always open, else the cron expression

getStart

public BusinessTemporal getStart()

Get the opening time of this period.

Returns:

when this period opens

getEnd

public BusinessTemporal getEnd()

Get the closing time of this period.

Returns:

when this period closes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Tells if this business period is equals to the given one. Business periods are equals if they are open at exactly the same times.

Overrides:

equals in class Object

Parameters:

obj - the object to comapre this period to

Returns:

true if the period are equals, false otherwise.

merge

public static Set<BusinessPeriod> merge(Collection<BusinessPeriod> periods)

Merge intersecting or adjacent periods.

Parameters:

periods - the periods to merge

Returns:

the merged periods. Their opening time spans will be exactly the same as the input periods.