CachedList

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.util.collection
Class CachedList

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractList
          org.jboss.util.collection.CachedList

All Implemented Interfaces:: java.util.Collection, java.util.List

public class CachedList
extends java.util.AbstractList

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

Field Summary
`protected java.util.List`	`list` Wrapped list.
`protected java.lang.ref.ReferenceQueue`	`queue` Reference queue.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary
`CachedList()` Construct a `CachedList` using a `LinkedList` for storage.
`CachedList(java.util.List list)` Construct a `CachedList`.

Method Summary
`void`	`add(int index, java.lang.Object obj)` Inserts the specified element at the specified position in this list (optional operation).
`java.lang.Object`	`get(int index)` Returns the element at the specified position in this list.
`java.lang.Object`	`remove(int index)` Removes the element at the specified position in this list (optional operation).
`java.lang.Object`	`set(int index, java.lang.Object obj)` Replaces the element at the specified position in this list with the specified element.
`int`	`size()` Return the size of the list.

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

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

Field Detail

queue

protected final java.lang.ref.ReferenceQueue queue

Reference queue.

list

protected final java.util.List list

Wrapped list.

Constructor Detail

CachedList

public CachedList(java.util.List list)

Construct a CachedList.
Parameters:: list - List to wrap.

CachedList

public CachedList()

Construct a CachedList using a LinkedList for storage.

Method Detail

get

public java.lang.Object get(int index)

Returns the element at the specified position in this list.

Parameters:: index - Index of element to return.
Returns:: The element at the specified position.

size

public int size()

Return the size of the list.

Returns:: The number of elements in the list.

set

public java.lang.Object set(int index,
                            java.lang.Object obj)

Replaces the element at the specified position in this list with the specified element.

Parameters:: index - Index of element to replace.; obj - Element to be stored at the specified postion.
Returns:: The previous element at the given index.

add

public void add(int index,
                java.lang.Object obj)

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:: index - Index at which the specified element is to be inserted.; obj - Element to be inserted.

remove

public java.lang.Object remove(int index)

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.