org.wiztools.commons

Class AbstractExpiryCollection<T>

java.lang.Object

org.wiztools.commons.AbstractExpiryCollection<T>

All Implemented Interfaces:

Iterable<T>, ExpiryCollection<T>

Direct Known Subclasses:

ExpiryArrayList, ExpiryHashSet

public abstract class AbstractExpiryCollection<T>
extends Object
implements ExpiryCollection<T>

Abstract class providing all the basic functionality of ExpiryCollection like cleaner thread and iterator.

Author:

subwiz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractExpiryCollection.Encp

Constructor Summary

Constructors

Constructor and Description
AbstractExpiryCollection(long cleanerThreadIntervalInMilliSecond)

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)
abstract Collection<AbstractExpiryCollection.Encp>	getData()
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExpiryCollection

public AbstractExpiryCollection(long cleanerThreadIntervalInMilliSecond)

Method Detail

getData

public abstract Collection<AbstractExpiryCollection.Encp> getData()

add

public boolean add(T t,
          long expiryTime)

Specified by:

add in interface ExpiryCollection<T>

clear

public void clear()

Specified by:

clear in interface ExpiryCollection<T>

contains

public boolean contains(T t)

Specified by:

contains in interface ExpiryCollection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ExpiryCollection<T>

size

public int size()

Specified by:

size in interface ExpiryCollection<T>

acquire

public void acquire()

Description copied from interface: ExpiryCollection

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.

Specified by:

acquire in interface ExpiryCollection<T>

release

public void release()

Description copied from interface: ExpiryCollection

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

Specified by:

release in interface ExpiryCollection<T>

shutdown

public void shutdown()

Description copied from interface: ExpiryCollection

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.

Specified by:

shutdown in interface ExpiryCollection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface ExpiryCollection<T>