Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.util

Class Expiring<T>

java.lang.Object

page.codeberg.friedolyn.util.Expiring<T>

Type Parameters:

T - The type of the value that will expire.

public class Expiring<T>
extends Object

A class that holds a value that will expire after a certain point in time or after a certain duration.

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull LocalDateTime	CREATION_TIME	The absolute point in time at which the value was created.
private @NonNull Duration	expirationDuration	The relative duration after which the value is considered expired, counting from the CREATION_TIME.
private @NonNull LocalDateTime	expirationTime	The absolute point in time after which the value is considered expired.
private T	value	The value that will expire.

Constructor Summary

Constructors

Constructor	Description
Expiring(T value, @NonNull Duration expirationDuration)	Creates a new expiring object with the given value and expiration duration.
Expiring(T value, @NonNull LocalDateTime expirationTime)	Creates a new expiring object with the given value and expiration time.
Expiring(T value, @NonNull LocalDateTime expirationTime, @NonNull Duration expirationDuration)	Creates a new expiring object with the given value, creation time and expiration duration.

Method Summary

Modifier and Type	Method	Description
void	extendBy(@NonNull Duration duration)	Extends both the absolute expiration time and the relative expiration duration by the given duration, even if the value has already expired.
boolean	extendIfExpired(@NonNull Duration duration)	Extends the expiration time and the expiration duration by the given duration, only if the value has already expired.
boolean	extendIfNotExpired(@NonNull Duration duration)	Extends the expiration time and the expiration duration by the given duration, only if the value has not expired.
@NonNull Optional<T>	get()	Returns the value if it has not expired yet, otherwise an empty Optional.
T	getEvenIfExpired()
boolean	hasExpired()
void	update(T value)	Updates the value without modifying the expiration time or duration.
void	updateExpirationTime(@NonNull LocalDateTime expirationTime)	Updates the absolute expiration time to the given time and recalculates the relative expiration duration.
boolean	updateExpirationTimeIfExpired(@NonNull LocalDateTime expirationTime)	Updates the relative expiration duration to the given duration and recalculates the absolute expiration time, only if the value has already expired.
boolean	updateExpirationTimeIfNotExpired(@NonNull LocalDateTime expirationTime)	Updates the absolute expiration time to the given time and recalculates the relative expiration duration, only if the value has not yet expired.
boolean	updateIfExpired(T value)	Updates the value only if it has already expired.
boolean	updateIfNotExpired(T value)	Updates the value only if it has not yet expired.

Methods inherited from class java.lang.Object

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

Field Details

value

@NonNull
private T value

The value that will expire.

CREATION_TIME

@NonNull
private final @NonNull LocalDateTime CREATION_TIME

The absolute point in time at which the value was created.

expirationTime

@NonNull
private @NonNull LocalDateTime expirationTime

The absolute point in time after which the value is considered expired.

expirationDuration

@NonNull
private @NonNull Duration expirationDuration

The relative duration after which the value is considered expired, counting from the CREATION_TIME.

Constructor Details

Expiring

public Expiring(@NonNull
 T value,
 @NonNull
 @NonNull Duration expirationDuration)

Creates a new expiring object with the given value and expiration duration.

Parameters:

value - The value that will expire.

expirationDuration - The relative duration after which the value is considered expired, counting from the creation time (now).

Expiring

public Expiring(@NonNull
 T value,
 @NonNull
 @NonNull LocalDateTime expirationTime)

Creates a new expiring object with the given value and expiration time.

Parameters:

value - The value that will expire.

expirationTime - The absolute point in time after which the value is considered expired.

Expiring

public Expiring(@NonNull
 T value,
 @NonNull
 @NonNull LocalDateTime expirationTime,
 @NonNull
 @NonNull Duration expirationDuration)

Creates a new expiring object with the given value, creation time and expiration duration. If expirationTime and expirationDuration differ, the minimum of both will be used. That means, get() will return Optional.empty() if at least one of the two expiration conditions is met.

Parameters:

value - The value that will expire.

expirationTime - The absolute point in time when the value is considered expired.

expirationDuration - The relative duration after which the value is considered expired, counting from the creation time (now).

Method Details

get

@NonNull
public @NonNull Optional<T> get()

Returns the value if it has not expired yet, otherwise an empty Optional. The value is considered expired if

• the current time is after the expiration time or
• the current time is after the creation time plus the expiration duration

Note that the expiration time and the expiration duration are independent of each other. If at least one of the two conditions is met, the value is considered expired.

Returns:

The value if it has not expired yet, otherwise an empty Optional.

getEvenIfExpired

public T getEvenIfExpired()

Returns:

The stored value, even if it hasExpired().

hasExpired

public boolean hasExpired()

Returns:

true if the absolute expirationTime or the relative expirationDuration has been reached, false if neither has been reached yet.

update

public void update(@NonNull
 T value)

Updates the value without modifying the expiration time or duration.

Parameters:

value - The new value.

updateIfExpired

public boolean updateIfExpired(@NonNull
 T value)

Updates the value only if it has already expired.

Parameters:

value - The new value.

Returns:

true if the value has been updated, false otherwise.

updateIfNotExpired

public boolean updateIfNotExpired(@NonNull
 T value)

Updates the value only if it has not yet expired.

Parameters:

value - The new value.

Returns:

true if the value has been updated, false otherwise.

updateExpirationTime

public void updateExpirationTime(@NonNull
 @NonNull LocalDateTime expirationTime)

Updates the absolute expiration time to the given time and recalculates the relative expiration duration.

Parameters:

expirationTime - The new absolute expirationTime

updateExpirationTimeIfExpired

public boolean updateExpirationTimeIfExpired(@NonNull
 @NonNull LocalDateTime expirationTime)

Updates the relative expiration duration to the given duration and recalculates the absolute expiration time, only if the value has already expired.

Parameters:

expirationTime - The new absolute expirationTime.

Returns:

true if the expiration time and duration have been updated, false otherwise.

updateExpirationTimeIfNotExpired

public boolean updateExpirationTimeIfNotExpired(@NonNull
 @NonNull LocalDateTime expirationTime)

Updates the absolute expiration time to the given time and recalculates the relative expiration duration, only if the value has not yet expired.

Parameters:

expirationTime - The new absolute expirationTime.

Returns:

true if the expiration time and duration have been updated, false otherwise.

extendBy

public void extendBy(@NonNull
 @NonNull Duration duration)

Extends both the absolute expiration time and the relative expiration duration by the given duration, even if the value has already expired.

Parameters:

duration - The duration by which to extend the expirationTime and the expirationDuration.

See Also:

• extendIfExpired(Duration)
• extendIfNotExpired(Duration)

extendIfExpired

public boolean extendIfExpired(@NonNull
 @NonNull Duration duration)

Extends the expiration time and the expiration duration by the given duration, only if the value has already expired.

Parameters:

duration - The duration by which to extend the expirationTime and the expirationDuration.

Returns:

true if the value has been extended, false otherwise.

See Also:

• extendBy(Duration)
• extendIfNotExpired(Duration)

extendIfNotExpired

public boolean extendIfNotExpired(@NonNull
 @NonNull Duration duration)

Extends the expiration time and the expiration duration by the given duration, only if the value has not expired.

Parameters:

duration - The duration by which to extend the expirationTime and the expirationDuration.

Returns:

true if the value has been extended, false otherwise.

See Also:

• extendBy(Duration)
• extendIfExpired(Duration)