com.helger.datetime.expiration

Interface IMutableExpirable

All Superinterfaces:

IExpirable

All Known Subinterfaces:

IMutableExpirableWithReplacement<DATATYPE>

All Known Implementing Classes:

Expirable, ExpirableWithReplacement

public interface IMutableExpirable
extends IExpirable

Interface for objects that can expire.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default com.helger.commons.state.EChange	resetExpiration() Remove any available expiration data.
com.helger.commons.state.EChange	setExpirationDateTime(LocalDateTime aExpirationDateTime) Change the expiration date time of this object.

Methods inherited from interface com.helger.datetime.expiration.IExpirable

getExpirationDateTime, isExpirationDefined, isExpiredAt, isExpiredNow

Method Detail

setExpirationDateTime

@Nonnull
com.helger.commons.state.EChange setExpirationDateTime(@Nullable
                                                                 LocalDateTime aExpirationDateTime)

Change the expiration date time of this object. If you want to remove the expiration, please call resetExpiration() instead.

Parameters:

aExpirationDateTime - The new expiration date time. May be null.

Returns:

EChange.CHANGED if the expiration date time changed, EChange.UNCHANGED otherwise.

resetExpiration

@Nonnull
default com.helger.commons.state.EChange resetExpiration()

Remove any available expiration data.

Returns:

EChange.CHANGED if the expiration was reset, EChange.UNCHANGED if no expiration was defined.