com.helger.datetime.expiration

Class Expirable

java.lang.Object

com.helger.datetime.expiration.Expirable

All Implemented Interfaces:

IExpirable, IMutableExpirable

public class Expirable
extends Object
implements IMutableExpirable

Default implementation of IMutableExpirable

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
Expirable()
Expirable(LocalDateTime aExpirationDateTime)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
LocalDateTime	getExpirationDateTime()
int	hashCode()
com.helger.commons.state.EChange	setExpirationDateTime(LocalDateTime aExpirationDateTime) Change the expiration date time of this object.
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

Expirable

public Expirable()

Expirable

public Expirable(@Nullable
                 LocalDateTime aExpirationDateTime)

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.

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