org.dhatim.businesshours

Class BusinessHours

java.lang.Object

org.dhatim.businesshours.BusinessHours

public class BusinessHours
extends Object

A representation of business hours.

The business hours are specified as a string which adheres to the format:

sub-period[, sub-period...]

If the period is blank, then the business supposed to be always open.
A sub-period is of the form:

  scale {range [range ...]} [scale {range [range ...]}]

Scale must be one of three different scales (or their equivalent codes):

Scale	Scale code	Valid range values
wday	wd	1 (Monday) to 7 (Sunday) or mo, tu, we, th, fr, sa, su
hour	hr	0-23 or 12am 1am-11am 12noon 12pm 1pm-11pm
minute	min	0-59

The same scale type may be specified multiple times. Additional scales simply extend the range defined by previous scales of the same type.
The range for a given scale must be a valid value in the form of v or v-v.
For the range specification v-v, if the second value is larger than the first value, the range wraps around.
v isn't a point in time. In the context of the hour scale, 9 specifies the time period from 9:00 am to 9:59. This is what most people would call 9-10.

Note that whitespaces can be anywhere. Furthermore, when using letters to specify week days, only the first two are significant and the case is not important: Sunday or Sun are valid specifications for su.

Examples:

To specify business hours that go from Monday through Friday, 9am to 5pm:

wd {Mon-Fri} hr {9am-4pm}

To specify business hours that go from Monday through Friday, 9am to 5pm on Monday, Wednesday, and Friday, and 9am to 3pm on Tuesday and Thursday, use a period such as:

wd {Mon Wed Fri} hr {9am-4pm}, wd{Tue Thu} hr {9am-2pm}

To specify business hours open every other half-hour, use something like:

minute { 0-29 }

To specify the morning, use:

hour { 12am-11am }

Remember, 11am is not 11:00am, but rather 11:00am - 11:59am.

Author:

Maxime Suret

Constructor Summary

Constructors

Constructor and Description
BusinessHours(String stringValue) Build a new instance of BusinessHours from its string representation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Tells if these business hours are equals to the given ones.
Set<String>	getClosingCrons() Get a set of crons corresponding to each closing.
Set<String>	getOpeningCrons() Get a set of crons corresponding to each opening.
int	hashCode() Returns a hash code for this BusinessHours.
boolean	isOpen(Temporal temporal) Tells if the business is open at the given time.
long	timeBeforeOpening(Temporal temporal, ChronoUnit unit) Get the time between the given temporal and the next business opening.
String	toString() Return a string representation of this BusinessHours instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessHours

public BusinessHours(String stringValue)

Build a new instance of BusinessHours from its string representation.

Parameters:

stringValue - the string representation of the business hours. See the class level Javadoc for more info on valid formats.

Method Detail

isOpen

public boolean isOpen(Temporal temporal)

Tells if the business is open at the given time.

Parameters:

temporal - the time when we want to know if the business is open or closed.

Returns:

true if the business is open at the given time, false otherwise

timeBeforeOpening

public long timeBeforeOpening(Temporal temporal,
                              ChronoUnit unit)

Get the time between the given temporal and the next business opening.

Parameters:

temporal - the temporal from which to compute the time before next opening

unit - the unit in which the result must be stated

Returns:

the duration,, or LONG.MAX_VALUE if the business is always open

getOpeningCrons

public Set<String> getOpeningCrons()

Get a set of crons corresponding to each opening. The set is empty if the business is always open.

Returns:

the cron set

getClosingCrons

public Set<String> getClosingCrons()

Get a set of crons corresponding to each closing. The set is empty if the business is always open.

Returns:

the cron set

hashCode

public int hashCode()

Returns a hash code for this BusinessHours.

Overrides:

hashCode in class Object

Returns:

a suitable hash code

equals

public boolean equals(Object obj)

Tells if these business hours are equals to the given ones.

Business hours are equals if they are open at exactly the same instants (regardless of the string representation used to build them).

Overrides:

equals in class Object

Parameters:

obj - the other BusinessHours, null returns false

Returns:

true if the other BusinessHours is equals to this one

toString

public String toString()

Return a string representation of this BusinessHours instance.

It is the same String as the one used to build this instance.

Overrides:

toString in class Object

Returns:

the string representation of this BusinessHours instance.