com.hazelcast.cache

Class HazelcastExpiryPolicy

java.lang.Object

com.hazelcast.cache.HazelcastExpiryPolicy

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, Serializable, javax.cache.expiry.ExpiryPolicy

public class HazelcastExpiryPolicy
extends Object
implements javax.cache.expiry.ExpiryPolicy, IdentifiedDataSerializable, Serializable

Hazelcast provides custom expiry policy on each cache operation. This class comes in handy for that functionality.

Sample usage:

     ICache<String , SessionData> icache =  cache.unwrap( ICache.class );
     HazelcastExpiryPolicy customExpiry = new HazelcastExpiryPolicy(20, 30, 40, TimeUnit.SECONDS);
     icache.put("key1", sessionData, customExpiry );
     
 

Since:

3.3.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HazelcastExpiryPolicy(javax.cache.expiry.Duration create, javax.cache.expiry.Duration access, javax.cache.expiry.Duration update) Constructs an expiry policy with provided values in Duration.
HazelcastExpiryPolicy(javax.cache.expiry.ExpiryPolicy expiryPolicy) Expiry policy wrapper.
HazelcastExpiryPolicy(long createMillis, long accessMillis, long updateMillis) Constructs an expiry policy with provided values in milliseconds.
HazelcastExpiryPolicy(long createDurationAmount, long accessDurationAmount, long updateDurationAmount, TimeUnit timeUnit) Constructs an expiry policy with provided values and TimeUnit.

Method Summary

Methods

Modifier and Type	Method and Description
javax.cache.expiry.Duration	getExpiryForAccess()
javax.cache.expiry.Duration	getExpiryForCreation()
javax.cache.expiry.Duration	getExpiryForUpdate()
int	getFactoryId() Returns DataSerializableFactory factory id for this class.
int	getId() Returns type identifier for this class.
void	readData(ObjectDataInput in) Reads fields from the input stream
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

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

Constructor Detail

HazelcastExpiryPolicy

public HazelcastExpiryPolicy(long createMillis,
                     long accessMillis,
                     long updateMillis)

Constructs an expiry policy with provided values in milliseconds.

Parameters:

createMillis -

accessMillis -

updateMillis -

HazelcastExpiryPolicy

public HazelcastExpiryPolicy(long createDurationAmount,
                     long accessDurationAmount,
                     long updateDurationAmount,
                     TimeUnit timeUnit)

Constructs an expiry policy with provided values and TimeUnit.

Parameters:

createDurationAmount -

accessDurationAmount -

updateDurationAmount -

timeUnit -

HazelcastExpiryPolicy

public HazelcastExpiryPolicy(javax.cache.expiry.ExpiryPolicy expiryPolicy)

Expiry policy wrapper.

Parameters:

expiryPolicy -

HazelcastExpiryPolicy

public HazelcastExpiryPolicy(javax.cache.expiry.Duration create,
                     javax.cache.expiry.Duration access,
                     javax.cache.expiry.Duration update)

Constructs an expiry policy with provided values in Duration.

Parameters:

create -

access -

update -

Method Detail

getExpiryForCreation

public javax.cache.expiry.Duration getExpiryForCreation()

Specified by:

getExpiryForCreation in interface javax.cache.expiry.ExpiryPolicy

getExpiryForAccess

public javax.cache.expiry.Duration getExpiryForAccess()

Specified by:

getExpiryForAccess in interface javax.cache.expiry.ExpiryPolicy

getExpiryForUpdate

public javax.cache.expiry.Duration getExpiryForUpdate()

Specified by:

getExpiryForUpdate in interface javax.cache.expiry.ExpiryPolicy

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory id for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory id

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. Id should be unique per DataSerializableFactory.

Specified by:

getId in interface IdentifiedDataSerializable

Returns:

type id

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException