org.apache.flex.abc

Class Pool<T>

java.lang.Object

org.apache.flex.abc.Pool<T>

Type Parameters:

T - the type of the Pool's elements. T must implement reasonable hashCode and equals methods. Notably, if it uses identity semantics then you will probably end up with duplicate entries in the constant pool.

public final class Pool<T>
extends Object

Abstract representation of an ABC pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pool.DefaultType A type-safe flag callers pass to the constructor to indicate whether or not the Pool has a default zero entry.

Constructor Summary

Constructors

Constructor and Description
Pool(Pool.DefaultType default_type) Construct a new Pool.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(T e) Add an element to the pool if it's not already present.
int	getNominalSize() When the only entry in a pool with a default zero entry is the default zero entry the nominal size of the pool is 0, otherwise the nominal size of the pool is the same as its size.
ArrayList<T>	getValues()
int	id(T e)
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Pool

public Pool(Pool.DefaultType default_type)

Construct a new Pool.

Parameters:

default_type - - one of HasDefaultZero or NoDefaultZero; the Pool will have a default meaning for its 0th entry if HasDefaultZero is passed in.

Method Detail

add

public int add(T e)

Add an element to the pool if it's not already present.

Parameters:

e - - the element to add.

Returns:

the element's position in the pool.

getValues

public ArrayList<T> getValues()

Returns:

the pool's elements in entry order.

id

public int id(T e)

Parameters:

e - - the element of interest.

Returns:

the element's position in the pool.

Throws:

IllegalArgumentException - if the element isn't in the pool.

size

public int size()

Returns:

the size of the pool; this is the size of the elements, plus one if the pool has a default zeroth element.

getNominalSize

public int getNominalSize()

When the only entry in a pool with a default zero entry is the default zero entry the nominal size of the pool is 0, otherwise the nominal size of the pool is the same as its size.

This method is need to compute the pool size to write into the ABC.

Returns:

The nominal size of the pool.

See Also:

size()

toString

public String toString()

Overrides:

toString in class Object