com.grey.base.collections

Class ObjectWell<T>

java.lang.Object

com.grey.base.collections.ObjectPile<T>

com.grey.base.collections.ObjectWell<T>

public final class ObjectWell<T>
extends ObjectPile<T>

An object container which also manufactures objects on demand.
This container extends ObjectPile by acting as an object well (or source), not just a passive store. That is, whereas ObjectPile only lets you take out what you put in, this class's extraction operation may result in new objects being created on demand (and will do so, on the first extraction).
You should only use its store() methods to return objects which were previously extracted from this well (which also means that they would have been originally created by this well), but beware that it does not enforce this.
If no factory is provided, this class auto-creates the stored object elements using their the default constructor.

Since objects start off on the well and are expected to be returned to it if and when the caller is done with them, the extract() method effectively hands objects out on loan, while the store() methods return them.
When we talk below about the "extant population", we mean the total number of objects in existence, whether currently stored in the well or out on loan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ObjectWell.ObjectFactory

Field Summary

Fields

Modifier and Type	Field and Description
String	name

Fields inherited from class com.grey.base.collections.ObjectPile

SYSPROP_UNIQUE

Constructor Summary

Constructors

Constructor and Description
ObjectWell(Class<?> c, ObjectWell.ObjectFactory f, String well_name, int initpop, int max)
ObjectWell(Class<?> c, ObjectWell.ObjectFactory f, String well_name, int initpop, int max, int incr)
ObjectWell(Class<?> c, String well_name)
ObjectWell(ObjectWell.ObjectFactory f, String well_name)

Method Summary

Modifier and Type	Method and Description
void	clear()
int	clear(int newmax)
T	extract()
int	maxPopulation()
int	population()

Methods inherited from class com.grey.base.collections.ObjectPile

bulkStore, bulkStore, size, store

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

Constructor Detail

ObjectWell

public ObjectWell(Class<?> c,
                  String well_name)

ObjectWell

public ObjectWell(ObjectWell.ObjectFactory f,
                  String well_name)

ObjectWell

public ObjectWell(Class<?> c,
                  ObjectWell.ObjectFactory f,
                  String well_name,
                  int initpop,
                  int max)

ObjectWell

public ObjectWell(Class<?> c,
                  ObjectWell.ObjectFactory f,
                  String well_name,
                  int initpop,
                  int max,
                  int incr)

Method Detail

population

public int population()

maxPopulation

public int maxPopulation()

extract

public T extract()

Overrides:

extract in class ObjectPile<T>

clear

public void clear()

Overrides:

clear in class ObjectPile<T>

clear

public int clear(int newmax)