io.doov.core.dsl.time

Class LocalDateSuppliers

java.lang.Object

io.doov.core.dsl.time.LocalDateSuppliers

public class LocalDateSuppliers
extends java.lang.Object

Common and useful local date suppliers. You can mock the clock by using setClock(Clock).

Method Summary

Modifier and Type	Method and Description
static java.time.Clock	createClockFrom(java.time.LocalDate localDate) Returns a clock from the given local date.
static TemporalFunction<java.time.LocalDate>	date(int year, int month, int dayOfMonth) Return a temporal condition that returns the local date from the given year, month, and day.
static TemporalFunction<java.time.LocalDate>	firstDayOfThisMonth() Return a temporal condition that returns today's local date at the first day of month.
static TemporalFunction<java.time.LocalDate>	firstDayOfThisYear() Return a temporal condition that returns today's local date at the first day of year.
static java.time.Clock	getClock() Returns the clock.
static boolean	isClockSet() Returns true if the clock is set.
static TemporalFunction<java.time.LocalDate>	lastDayOfThisMonth() Return a temporal condition that returns today's local date at the last day of month.
static TemporalFunction<java.time.LocalDate>	lastDayOfThisYear() Return a temporal condition that returns today's local date at the last day of year.
static void	setClock(java.time.Clock clock) Sets the clock.
static void	setDefaultClock() Removes the clock.
static TemporalFunction<java.time.LocalDate>	today() Return a temporal condition that returns today's local date.
static TemporalFunction<java.time.LocalDate>	todayMinus(int amountToSubstract, java.time.temporal.TemporalUnit unit) Return a temporal condition that returns today's local date minus the given amount and unit.
static TemporalFunction<java.time.LocalDate>	todayMinusDays(int daysToSubstract) Return a temporal condition that returns today's local date minus the given amount in days.
static TemporalFunction<java.time.LocalDate>	todayMinusYears(int yearsToSubstract) Return a temporal condition that returns today's local date minus the given amount in years.
static TemporalFunction<java.time.LocalDate>	todayPlus(int amountToAdd, java.time.temporal.TemporalUnit unit) Return a temporal condition that returns today's local date plus the given amount and unit.
static TemporalFunction<java.time.LocalDate>	todayPlusDays(int daysToAdd) Return a temporal condition that returns today's local date plus the given amount in days.
static TemporalFunction<java.time.LocalDate>	todayPlusYears(int yearsToAdd) Return a temporal condition that returns today's local date plus the given amount in years.

Methods inherited from class java.lang.Object

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

Method Detail

createClockFrom

public static java.time.Clock createClockFrom(java.time.LocalDate localDate)

Returns a clock from the given local date.

Parameters:

localDate - the date to set the clock at

Returns:

the new clock

isClockSet

public static boolean isClockSet()

Returns true if the clock is set.

Returns:

true if set

setClock

public static void setClock(java.time.Clock clock)

Sets the clock.

Parameters:

clock - the clock to set

getClock

public static java.time.Clock getClock()

Returns the clock.

Returns:

the clock

setDefaultClock

public static void setDefaultClock()

Removes the clock.

today

public static TemporalFunction<java.time.LocalDate> today()

Return a temporal condition that returns today's local date.

Returns:

the temporal condition

todayPlus

public static TemporalFunction<java.time.LocalDate> todayPlus(int amountToAdd,
                                                              java.time.temporal.TemporalUnit unit)

Return a temporal condition that returns today's local date plus the given amount and unit.

Parameters:

amountToAdd - the amount to add

unit - the unit of the amount

Returns:

the temporal condition

todayPlusDays

public static TemporalFunction<java.time.LocalDate> todayPlusDays(int daysToAdd)

Return a temporal condition that returns today's local date plus the given amount in days.

Parameters:

daysToAdd - the amount of days to add

Returns:

the temporal condition

todayPlusYears

public static TemporalFunction<java.time.LocalDate> todayPlusYears(int yearsToAdd)

Return a temporal condition that returns today's local date plus the given amount in years.

Parameters:

yearsToAdd - the amount of years to add

Returns:

the temporal condition

todayMinus

public static TemporalFunction<java.time.LocalDate> todayMinus(int amountToSubstract,
                                                               java.time.temporal.TemporalUnit unit)

Return a temporal condition that returns today's local date minus the given amount and unit.

Parameters:

amountToSubstract - the amount to remove

unit - the unit of the amount

Returns:

the temporal condition

todayMinusDays

public static TemporalFunction<java.time.LocalDate> todayMinusDays(int daysToSubstract)

Return a temporal condition that returns today's local date minus the given amount in days.

Parameters:

daysToSubstract - the amount of days to remove

Returns:

the temporal condition

todayMinusYears

public static TemporalFunction<java.time.LocalDate> todayMinusYears(int yearsToSubstract)

Return a temporal condition that returns today's local date minus the given amount in years.

Parameters:

yearsToSubstract - the amount of years to remove

Returns:

the temporal condition

firstDayOfThisMonth

public static TemporalFunction<java.time.LocalDate> firstDayOfThisMonth()

Return a temporal condition that returns today's local date at the first day of month.

Returns:

the temporal condition

firstDayOfThisYear

public static TemporalFunction<java.time.LocalDate> firstDayOfThisYear()

Return a temporal condition that returns today's local date at the first day of year.

Returns:

the temporal condition

lastDayOfThisMonth

public static TemporalFunction<java.time.LocalDate> lastDayOfThisMonth()

Return a temporal condition that returns today's local date at the last day of month.

Returns:

the temporal condition

lastDayOfThisYear

public static TemporalFunction<java.time.LocalDate> lastDayOfThisYear()

Return a temporal condition that returns today's local date at the last day of year.

Returns:

the temporal condition

date

public static TemporalFunction<java.time.LocalDate> date(int year,
                                                         int month,
                                                         int dayOfMonth)

Return a temporal condition that returns the local date from the given year, month, and day.

Parameters:

year - the year of the date

month - the month of the date

dayOfMonth - the day of the date

Returns:

the temporal condition