org.dhatim.businesshours

Class BusinessTemporal

java.lang.Object

org.dhatim.businesshours.BusinessTemporal

All Implemented Interfaces:

Comparable<Temporal>, Temporal, TemporalAccessor

public class BusinessTemporal
extends Object
implements Temporal, Comparable<Temporal>

A temporal containing fields that can be used to define business hours. These fields must be continguous and have a fixed range.

Author:

Maxime Suret

Method Summary

Modifier and Type	Method and Description
int	compareTo(Temporal t)
boolean	equals(Object obj) Tells if this business temporal is equals to another one.
long	getLong(TemporalField field)
int	hashCode()
BusinessTemporal	increment() Increments the least significant field of this Business Temporal by one.
boolean	isSupported(TemporalField field)
boolean	isSupported(TemporalUnit unit)
static BusinessTemporal	of(Map<ChronoField,Integer> fieldValues) Builds a BusinessTemporal instance from its fields values
Temporal	plus(long amountToAdd, TemporalUnit unit)
<R> R	query(TemporalQuery<R> query)
long	since(Temporal temporal, ChronoUnit unit) Get the amount of time between the provided temporal and the next occurrence of this business temporal.
long	until(Temporal endExclusive, TemporalUnit unit)
Temporal	with(TemporalField field, long newValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.time.temporal.Temporal

minus, minus, plus, with

Methods inherited from interface java.time.temporal.TemporalAccessor

get, range

Method Detail

of

public static BusinessTemporal of(Map<ChronoField,Integer> fieldValues)

Builds a BusinessTemporal instance from its fields values

Parameters:

fieldValues - the values of the fields. The fields must be contiguous and have a fixed range.

Returns:

the BusinessTemporal instance

query

public <R> R query(TemporalQuery<R> query)

Specified by:

query in interface TemporalAccessor

isSupported

public boolean isSupported(TemporalField field)

Specified by:

isSupported in interface TemporalAccessor

getLong

public long getLong(TemporalField field)

Specified by:

getLong in interface TemporalAccessor

isSupported

public boolean isSupported(TemporalUnit unit)

Specified by:

isSupported in interface Temporal

with

public Temporal with(TemporalField field,
                     long newValue)

Specified by:

with in interface Temporal

plus

public Temporal plus(long amountToAdd,
                     TemporalUnit unit)

Specified by:

plus in interface Temporal

until

public long until(Temporal endExclusive,
                  TemporalUnit unit)

Specified by:

until in interface Temporal

increment

public BusinessTemporal increment()

Increments the least significant field of this Business Temporal by one.

Returns:

a new Business Temporal with the incremented field

since

public long since(Temporal temporal,
                  ChronoUnit unit)

Get the amount of time between the provided temporal and the next occurrence of this business temporal. Contrary to 'until', this method returns a result of a precision equivalent to the precision of the provided temporal, and guarantees that the result will be positive

Parameters:

temporal - the temporal, must support the "precision" query

unit - the unit to measure the amount in

Returns:

the time between the given temporal and this business temporal (always positive)

compareTo

public int compareTo(Temporal t)

Specified by:

compareTo in interface Comparable<Temporal>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Tells if this business temporal is equals to another one. Two business temporals are equals if they support the same fields, and these fields have the same values.

Overrides:

equals in class Object

Parameters:

obj - the object to comapare this business tempral to

Returns:

true if this object and obj are equals, false otherwise.