com.helger.datetime.expiration

Class ExpirableWithReplacement<DATATYPE>

java.lang.Object

com.helger.datetime.expiration.ExpirableWithReplacement<DATATYPE>

Type Parameters:

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

All Implemented Interfaces:

IExpirable, IExpirableWithReplacement<DATATYPE>, IMutableExpirable, IMutableExpirableWithReplacement<DATATYPE>, Serializable

public class ExpirableWithReplacement<DATATYPE>
extends Object
implements IMutableExpirableWithReplacement<DATATYPE>

Default implementation of IMutableExpirableWithReplacement

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExpirableWithReplacement()
ExpirableWithReplacement(LocalDateTime aExpirationDateTime, DATATYPE aReplacement)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
LocalDateTime	getExpirationDateTime()
DATATYPE	getReplacement() In case the object has an expiration date defined and is expired, the object returned by this method directs to replacement object to be used instead.
int	hashCode()
com.helger.commons.state.EChange	setExpirationDateTime(LocalDateTime aExpirationDateTime) Change the expiration date time of this object.
com.helger.commons.state.EChange	setReplacement(DATATYPE aReplacement) Define a replacement in case this object expires.
String	toString()

Methods inherited from class java.lang.Object

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

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

resetExpiration

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

isExpirationDefined, isExpiredAt, isExpiredNow

Constructor Detail

ExpirableWithReplacement

public ExpirableWithReplacement()

ExpirableWithReplacement

public ExpirableWithReplacement(@Nullable
                                LocalDateTime aExpirationDateTime,
                                @Nullable
                                DATATYPE aReplacement)

Method Detail

getExpirationDateTime

@Nullable
public LocalDateTime getExpirationDateTime()

Specified by:

getExpirationDateTime in interface IExpirable

Returns:

The date time when the object will expire/expired. May be null if no expiration is defined.

setExpirationDateTime

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

Description copied from interface: IMutableExpirable

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

Specified by:

setExpirationDateTime in interface IMutableExpirable

Parameters:

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

Returns:

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

getReplacement

@Nullable
public DATATYPE getReplacement()

Description copied from interface: IExpirableWithReplacement

In case the object has an expiration date defined and is expired, the object returned by this method directs to replacement object to be used instead.

Specified by:

getReplacement in interface IExpirableWithReplacement<DATATYPE>

Returns:

null if no replacement is defined, a non- null object otherwise.

setReplacement

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

Description copied from interface: IMutableExpirableWithReplacement

Define a replacement in case this object expires.

Specified by:

setReplacement in interface IMutableExpirableWithReplacement<DATATYPE>

Parameters:

aReplacement - The replacement object to use.

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object