net.fortytwo.stream.shj

Interface Expirable

All Known Implementing Classes:

Query, Solution

public interface Expirable

Author:

Joshua Shinavier (http://fortytwo.net)

Method Summary

Modifier and Type	Method and Description
void	expire() An operation to be executed when an item expires.
long	getExpirationTime() Gets the expiration time for this object
boolean	isExpired() Tests the object for "tombstone" status

Method Detail

getExpirationTime

long getExpirationTime()

Gets the expiration time for this object

Returns:

an expiration time, in milliseconds since the Unix epoch. The special value 0 indicates that the object is valid indefinitely.

expire

void expire()

An operation to be executed when an item expires. Turns the object into a "tombstone" which occupies minimal memory in the expiration heap. This is an alternative to removing an object from the heap, which is expensive; the tombstone exists until it expires, but must not be used.

isExpired

boolean isExpired()

Tests the object for "tombstone" status

Returns:

whether this object is a tombstone which must not be used