Package com.thanlinardos.spring_enterprise_library.time.api

Interface DateTemporal

All Known Implementing Classes:

Interval

public interface DateTemporal

Interface representing a temporal entity with a date interval.

Method Summary

Modifier and Type	Method	Description
default boolean	containsDate(LocalDate date)	Checks if the temporal entity contains the specified date.
default boolean	containsInterval(DateTemporal interval)	Checks if the temporal entity contains another temporal entity's interval.
default boolean	containsMonth(YearMonth yearMonth)	Checks if the temporal entity contains the specified month.
default boolean	endsAfter(LocalDate date)	Checks if the interval of this temporal entity ends after the specified date.
default boolean	endsAfterOrOn(LocalDate date)	Checks if the interval of this temporal entity ends after or on the specified date.
default boolean	equalsInterval(DateTemporal interval)	Checks if the interval of this temporal entity is equal to another temporal entity's interval.
Interval	getInterval()	Gets the date interval of the temporal entity.
default boolean	isContainedIn(DateTemporal interval)	Checks if the temporal entity is contained within another temporal entity's interval.
default boolean	isContainedIn(LocalDate from, LocalDate to)	Checks if the temporal entity is contained within the specified date range.
default boolean	isInRange(LocalDate from, LocalDate to)	Checks if the temporal entity is within the specified date range.
default boolean	overlapsInterval(DateTemporal interval)	Checks if the interval of this temporal entity overlaps with another temporal entity's interval.
default boolean	overlapsInterval(LocalDate start, LocalDate end)	Checks if the interval of this temporal entity overlaps with the specified date range.
default boolean	overlapsMonth(YearMonth yearMonth)	Checks if the interval of this temporal entity overlaps with the specified month.
default boolean	overlapsYear(LocalDate yearDate)	Checks if the interval of this temporal entity overlaps with the year of the specified date.
default boolean	overlapsYear(Year year)	Checks if the interval of this temporal entity overlaps with the specified year.
default boolean	startsAfter(LocalDate date)	Checks if the interval of this temporal entity starts after the specified date.
default boolean	startsBefore(LocalDate date)	Checks if the interval of this temporal entity starts before the specified date.
default boolean	startsBeforeOrOn(LocalDate date)	Checks if the interval of this temporal entity starts before or on the specified date.

Method Details

getInterval

Interval getInterval()

Gets the date interval of the temporal entity.

Returns:

the date interval.

isInRange

default boolean isInRange(LocalDate from,
 LocalDate to)

Checks if the temporal entity is within the specified date range.

Parameters:

from - the start date of the range.

to - the end date of the range.

Returns:

true if the temporal entity is within the range, false otherwise.

isContainedIn

default boolean isContainedIn(DateTemporal interval)

Checks if the temporal entity is contained within another temporal entity's interval.

Parameters:

interval - the other temporal entity.

Returns:

true if this entity is contained within the other entity's interval, false otherwise.

isContainedIn

default boolean isContainedIn(LocalDate from,
 LocalDate to)

Checks if the temporal entity is contained within the specified date range.

Parameters:

from - the start date of the range.

to - the end date of the range.

Returns:

true if the temporal entity is contained within the range, false otherwise.

containsInterval

default boolean containsInterval(DateTemporal interval)

Checks if the temporal entity contains another temporal entity's interval.

Parameters:

interval - the other temporal entity.

Returns:

true if this entity contains the other entity's interval, false otherwise.

containsDate

default boolean containsDate(LocalDate date)

Checks if the temporal entity contains the specified date.

Parameters:

date - the date to check.

Returns:

true if the temporal entity contains the date, false otherwise.

containsMonth

default boolean containsMonth(YearMonth yearMonth)

Checks if the temporal entity contains the specified month.

Parameters:

yearMonth - the month to check.

Returns:

true if the temporal entity contains the month, false otherwise.

equalsInterval

default boolean equalsInterval(DateTemporal interval)

Checks if the interval of this temporal entity is equal to another temporal entity's interval.

Parameters:

interval - the other temporal entity.

Returns:

true if the intervals are equal, false otherwise.

overlapsInterval

default boolean overlapsInterval(DateTemporal interval)

Checks if the interval of this temporal entity overlaps with another temporal entity's interval.

Parameters:

interval - the other temporal entity.

Returns:

true if the intervals overlap, false otherwise.

overlapsMonth

default boolean overlapsMonth(YearMonth yearMonth)

Checks if the interval of this temporal entity overlaps with the specified month.

Parameters:

yearMonth - the month to check.

Returns:

true if the interval overlaps with the month, false otherwise.

overlapsYear

default boolean overlapsYear(Year year)

Checks if the interval of this temporal entity overlaps with the specified year.

Parameters:

year - the year to check.

Returns:

true if the interval overlaps with the year, false otherwise.

overlapsYear

default boolean overlapsYear(LocalDate yearDate)

Checks if the interval of this temporal entity overlaps with the year of the specified date.

Parameters:

yearDate - the date whose year to check.

Returns:

true if the interval overlaps with the year, false otherwise.

overlapsInterval

default boolean overlapsInterval(LocalDate start,
 LocalDate end)

Checks if the interval of this temporal entity overlaps with the specified date range.

Parameters:

start - the start date of the range.

end - the end date of the range.

Returns:

true if the intervals overlap, false otherwise.

startsAfter

default boolean startsAfter(LocalDate date)

Checks if the interval of this temporal entity starts after the specified date.

Parameters:

date - the date to check.

Returns:

true if the interval starts after the date, false otherwise.

endsAfter

default boolean endsAfter(LocalDate date)

Checks if the interval of this temporal entity ends after the specified date.

Parameters:

date - the date to check.

Returns:

true if the interval ends after the date, false otherwise.

endsAfterOrOn

default boolean endsAfterOrOn(LocalDate date)

Checks if the interval of this temporal entity ends after or on the specified date.

Parameters:

date - the date to check.

Returns:

true if the interval ends after or on the date, false otherwise.

startsBefore

default boolean startsBefore(LocalDate date)

Checks if the interval of this temporal entity starts before the specified date.

Parameters:

date - the date to check.

Returns:

true if the interval starts before the date, false otherwise.

startsBeforeOrOn

default boolean startsBeforeOrOn(LocalDate date)

Checks if the interval of this temporal entity starts before or on the specified date.

Parameters:

date - the date to check.

Returns:

true if the interval starts before or on the date, false otherwise.