Package org.ametys.core.util.date

Class AdaptableDate

java.lang.Object

org.ametys.core.util.date.AdaptableDate

public final class AdaptableDate
extends Object

This represents an advanced LocalDateTime, allowing to be a static one, or a relative one to the moment the resolveDateTime() method is called.
A single instance of AdaptableDate can be resolved mutliple times, without being a problem at all, it just can lead to different results.

You can get an AdaptableDate with:

• fromDateTime(java.time.LocalDateTime) to have a static one, always resolved as the same given LocalDateTime
• fromDate(java.time.LocalDate) to have a static one, always resolved as the same given LocalDate (at the start of the day)
• now() to have one resolved as the current LocalDateTime when resolveDateTime() is called
• future(org.ametys.core.util.date.AdaptableDate.AdaptableDateType, long, java.time.temporal.TemporalUnit) to have one resolved with the given amount of given TemporalUnit added to the current LocalDateTime when resolveDateTime() is called
• past(org.ametys.core.util.date.AdaptableDate.AdaptableDateType, long, java.time.temporal.TemporalUnit) to have one resolved with the given amount of given TemporalUnit subtracted to the current LocalDateTime when resolveDateTime() is called

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AdaptableDate.AdaptableDateType	Ways available to resolve dates.
static final record	AdaptableDate.DateTimeInterval	Interval of LocalDateTime

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static AdaptableDate	fromDate(LocalDate date)	Gets a static AdaptableDate, always resolved as the given LocalDate
static AdaptableDate	fromDateTime(LocalDateTime dateTime)	Gets a static AdaptableDate, always resolved as the given LocalDateTime
static AdaptableDate	future(AdaptableDate.AdaptableDateType type, long amount, TemporalUnit unit)	Gets an AdaptableDate, resolved as the current LocalDateTime at the moment of the call, plus the given amount of the given TemporalUnit, so as to get a LocalDateTime in the future
int	hashCode()
static AdaptableDate	now()	Gets an AdaptableDate, resolved as the current LocalDateTime at the moment of the call
static AdaptableDate	past(AdaptableDate.AdaptableDateType type, long amount, TemporalUnit unit)	Gets an AdaptableDate, resolved as the current LocalDateTime at the moment of the call, minus the given amount of the given TemporalUnit, so as to get a LocalDateTime in the past
LocalDate	resolveDate()	Resolves this AdaptableDate
AdaptableDate.DateTimeInterval	resolveDateTime()	Resolves this AdaptableDate
static AdaptableDate	today()	Gets an AdaptableDate, resolved at the beggining of the current day at the moment of the call
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

fromDateTime

public static AdaptableDate fromDateTime(LocalDateTime dateTime)

Gets a static AdaptableDate, always resolved as the given LocalDateTime

Parameters:

dateTime - The LocalDateTime

Returns:

The AdaptableDate

fromDate

public static AdaptableDate fromDate(LocalDate date)

Gets a static AdaptableDate, always resolved as the given LocalDate

Parameters:

date - The LocalDate

Returns:

The AdaptableDate

now

public static AdaptableDate now()

Gets an AdaptableDate, resolved as the current LocalDateTime at the moment of the call

Returns:

The AdaptableDate

today

public static AdaptableDate today()

Gets an AdaptableDate, resolved at the beggining of the current day at the moment of the call

Returns:

The AdaptableDate

past

public static AdaptableDate past(AdaptableDate.AdaptableDateType type,
 long amount,
 TemporalUnit unit)

Gets an AdaptableDate, resolved as the current LocalDateTime at the moment of the call, minus the given amount of the given TemporalUnit, so as to get a LocalDateTime in the past

Parameters:

type - the type of the offset to consider (relative to now or the beginning of the current day)

amount - The amount to subtract

unit - The TemporalUnit of the amount to subtract

Returns:

The AdaptableDate

future

public static AdaptableDate future(AdaptableDate.AdaptableDateType type,
 long amount,
 TemporalUnit unit)

Gets an AdaptableDate, resolved as the current LocalDateTime at the moment of the call, plus the given amount of the given TemporalUnit, so as to get a LocalDateTime in the future

Parameters:

type - the type of the offset to consider (relative to now or the beginning of the current day)

amount - The amount to add

unit - The TemporalUnit of the amount to add

Returns:

The AdaptableDate

resolveDateTime

public AdaptableDate.DateTimeInterval resolveDateTime()

Resolves this AdaptableDate

Returns:

The resolved LocalDateTime

resolveDate

public LocalDate resolveDate()

Resolves this AdaptableDate

Returns:

The resolved LocalDate

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object