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(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(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 and Description
private static class	AdaptableDate.AdaptableDateType
private static class	AdaptableDate.OffsetType

Field Summary

Fields

Modifier and Type	Field and Description
private static AdaptableDate	__NOW
private long	_relativeAmount
private AdaptableDate.OffsetType	_relativeOffsetType
private TemporalUnit	_relativeUnit
private LocalDateTime	_staticValue
private AdaptableDate.AdaptableDateType	_type

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AdaptableDate(AdaptableDate.OffsetType offsetType, long amount, TemporalUnit unit)
private	AdaptableDate(LocalDateTime date)

Method Summary

Modifier and Type	Method and Description
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(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
static AdaptableDate	now() Gets an AdaptableDate, resolved as the current LocalDateTime at the moment of the call
static AdaptableDate	past(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
LocalDateTime	resolveDateTime() Resolves this AdaptableDate
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__NOW

private static final AdaptableDate __NOW

_type

private final AdaptableDate.AdaptableDateType _type

_staticValue

private final LocalDateTime _staticValue

_relativeUnit

private final TemporalUnit _relativeUnit

_relativeAmount

private final long _relativeAmount

_relativeOffsetType

private final AdaptableDate.OffsetType _relativeOffsetType

Constructor Detail

AdaptableDate

private AdaptableDate(LocalDateTime date)

AdaptableDate

private AdaptableDate(AdaptableDate.OffsetType offsetType,
                      long amount,
                      TemporalUnit unit)

Method Detail

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

past

public static AdaptableDate past(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:

amount - The amount to subtract

unit - The TemporalUnit of the amount to subtract

Returns:

The AdaptableDate

future

public static AdaptableDate future(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:

amount - The amount to add

unit - The TemporalUnit of the amount to add

Returns:

The AdaptableDate

resolveDateTime

public LocalDateTime 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