com.helger.datetime.expiration

Interface IMutableExpirableWithReplacement<DATATYPE>

Type Parameters:

DATATYPE - The type of the object use for defining a replacement.

All Superinterfaces:

IExpirable, IExpirableWithReplacement<DATATYPE>, IMutableExpirable

All Known Implementing Classes:

ExpirableWithReplacement

public interface IMutableExpirableWithReplacement<DATATYPE>
extends IMutableExpirable, IExpirableWithReplacement<DATATYPE>

Interface for objects that can expire but offer a replacement once the object expires.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.state.EChange	setReplacement(DATATYPE aReplacement) Define a replacement in case this object expires.

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

resetExpiration, setExpirationDateTime

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

getReplacement

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

getExpirationDateTime, isExpirationDefined, isExpiredAt, isExpiredNow

Method Detail

setReplacement

@Nonnull
com.helger.commons.state.EChange setReplacement(@Nullable
                                                          DATATYPE aReplacement)

Define a replacement in case this object expires.

Parameters:

aReplacement - The replacement object to use.

Returns:

EChange.CHANGED if something was changed, EChange.UNCHANGED otherwise.