org.wiztools.commons

Interface ExpiryCollection<T>

All Superinterfaces:

Iterable<T>

All Known Implementing Classes:

AbstractExpiryCollection, ExpiryArrayList, ExpiryHashSet

public interface ExpiryCollection<T>
extends Iterable<T>

When adding elements to this collection type, we need to specify when the element will be expired and removed from the collection.

Author:

subwiz

Method Summary

Methods

Modifier and Type	Method and Description
void	acquire() Before running sequence of operations on the collection (like iterating, adding element, etc.), it is recommended to acquire the lock so that the cleaner thread does not run in-between the operation.
boolean	add(T t, long expiryTime)
void	clear()
boolean	contains(T t)
boolean	isEmpty()
Iterator<T>	iterator()
void	release() Whenever lock is acquired, make sure to release it (preferably in finally block).
void	shutdown() Call to this method will send a interrupt signal to the cleaner thread and make it quit.
int	size()

Method Detail

add

boolean add(T t,
          long expiryTime)

clear

void clear()

contains

boolean contains(T t)

isEmpty

boolean isEmpty()

iterator

Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

size

int size()

acquire

void acquire()

Before running sequence of operations on the collection (like iterating, adding element, etc.), it is recommended to acquire the lock so that the cleaner thread does not run in-between the operation.

release

void release()

Whenever lock is acquired, make sure to release it (preferably in finally block).

shutdown

void shutdown()

Call to this method will send a interrupt signal to the cleaner thread and make it quit. Call this method when you are done with the this collection.