org.jboss.util.collection

Class CachedCollection

java.lang.Object

java.util.AbstractCollection

org.jboss.util.collection.CachedCollection

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection

public class CachedCollection
extends java.util.AbstractCollection

A wrapper around a Collection which translates added objects into SoftObject references, allowing the VM to garbage collect objects in the collection when memory is low.

Version:

$Revision$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	CachedCollection.MyIterator A dereferencing iterator.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection	collection Wrapped collection
protected java.lang.ref.ReferenceQueue	queue Reference queue

Constructor Summary

Constructors

Constructor and Description
CachedCollection(java.util.Collection collection) Construct a CachedCollection.

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Object obj) Add an object to the collection.
java.util.Iterator	iterator() Returns an iterator over the elements contained in this collection.
private void	maintain() Maintains the collection by removing garbage collected objects.
int	size() Returns the size of the collection.

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

queue

protected final java.lang.ref.ReferenceQueue queue

Reference queue

collection

protected final java.util.Collection collection

Wrapped collection

Constructor Detail

CachedCollection

public CachedCollection(java.util.Collection collection)

Construct a CachedCollection.

Parameters:

collection - Collection to wrap.

Method Detail

iterator

public java.util.Iterator iterator()

Returns an iterator over the elements contained in this collection.

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in class java.util.AbstractCollection

Returns:

An iterator over the elements contained in this collection.

size

public int size()

Returns the size of the collection.

Specified by:

size in interface java.util.Collection

Specified by:

size in class java.util.AbstractCollection

Returns:

The number of elements in the collection.

add

public boolean add(java.lang.Object obj)

Add an object to the collection.

Specified by:

add in interface java.util.Collection

Overrides:

add in class java.util.AbstractCollection

Parameters:

obj - Object (or null to add to the collection.

Returns:

True if object was added.

maintain

private void maintain()

Maintains the collection by removing garbage collected objects.