app.pickmaven.businessdays

Class TemporalRange

java.lang.Object

app.pickmaven.businessdays.TemporalRange

public class TemporalRange
extends Object

The base unit to refer to a temporal range between two LocalDate objects.

This class is immutable and thread-safe

Author:

Daniele Gubbiotti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemporalRange.Builder Public builder for creating instances of app.pickmaven.businessdays.TemporalRange objects.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Checks if two app.pickmaven.businessdays.TemporalRange objects are equal.
java.time.LocalDate	getEndingDate() Gets the ending date of app.pickmaven.businessdays.TemporalRange
java.time.LocalDate	getStartingDate() Gets the starting date of app.pickmaven.businessdays.TemporalRange
int	hashCode() Computes the hashcode
boolean	includes(java.time.LocalDate date) Checks if this temporal range includes the parameter date.
boolean	includes(TemporalRange range) Checks if this temporal range includes the parameter range.
String	toString() Outputs the temporal range from starting date to ending one.

Methods inherited from class java.lang.Object

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

Method Detail

getStartingDate

public java.time.LocalDate getStartingDate()

Gets the starting date of app.pickmaven.businessdays.TemporalRange

Returns:

LocalDate of startingDate

getEndingDate

public java.time.LocalDate getEndingDate()

Gets the ending date of app.pickmaven.businessdays.TemporalRange

Returns:

endingDate

includes

public boolean includes(TemporalRange range)

Checks if this temporal range includes the parameter range.

Parameters:

range - must not be null

Returns:

true if this temporal range includes the parameter range

includes

public boolean includes(java.time.LocalDate date)

Checks if this temporal range includes the parameter date.

Parameters:

date - must not be null

Returns:

true if this temporal range includes the date

hashCode

public int hashCode()

Computes the hashcode

Overrides:

hashCode in class Object

Returns:

hashcode

equals

public boolean equals(Object o)

Checks if two app.pickmaven.businessdays.TemporalRange objects are equal. It compares the value of startingDate and endingDate.

Overrides:

equals in class Object

Parameters:

o - TemporalRange to check equality

Returns:

true if the two objects are equal

toString

public String toString()

Outputs the temporal range from starting date to ending one.

Overrides:

toString in class Object

Returns:

string representing TemporalRange