com.tensegrity.composite.geometry
Class GeometryPool

java.lang.Object
  com.tensegrity.composite.geometry.GeometryPool

public class GeometryPool

extends java.lang.Object

This class is a pool for GeometryDescriptor instances.

Version:

$Id: GeometryPool.java,v 1.18 2005/12/12 15:20:46 MichaelKegel Exp $

Author:

MichaelKegel

Method Summary

static void	clear() Clears the pool.
static void	dump(java.io.PrintStream s) Dumps the pool to the PrintStream given by the parameter s.
static GeometryDescriptor	get(java.lang.String name) Returns the instance of the GeometryDescriptor with the given name if any.
static boolean	isAvailable(java.lang.String name) Returns a boolean that indicates whether a GeometryDescriptor with the name given by name is in the pool or not.
static java.util.Set	names() Method names returns a set the keys of the internal poolGeometries map.
static void	pool(GeometryDescriptor geometry) Adds the given GeometryDescriptor to the list of pooled descriptors.
static GeometryDescriptor	remove(java.lang.String name) Removes the GeometryDescriptor with the given name from the pool.
static int	size() Returns the size of the pool.
static void	useThreadLocal() A call to this method configures the GeometryPool to make use of the ThreadLocal class hence a pool is created for each Thread the GeometryPool is used by.

Methods inherited from class java.lang.Object

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

Method Detail

useThreadLocal

public static final void useThreadLocal()

A call to this method configures the GeometryPool to make use of the ThreadLocal class hence a pool is created for each Thread the GeometryPool is used by.
Notice: This configuration must be done before the GeometryPool is in use by any Thread.

See Also:

ThreadLocal

isAvailable

public static final boolean isAvailable(java.lang.String name)

Returns a boolean that indicates whether a GeometryDescriptor with the name given by name is in the pool or not.

Parameters:

name - the name of the GeometryDescriptor to check

Returns:

boolean flag that indicates whether a GeometryDescriptor with the given name is available or not

get

public static final GeometryDescriptor get(java.lang.String name)

Returns the instance of the GeometryDescriptor with the given name if any. Null is returned, if there is no pooled instance with the given name.

Parameters:

name - the name of the GeometryDescriptor to retrieve.

Returns:

GeometryDescriptor the GeometryDescriptor with the given name; null if there is none.

pool

public static final void pool(GeometryDescriptor geometry)

Adds the given GeometryDescriptor to the list of pooled descriptors. To retrieve pooled instance, use the name of the GeometryDescriptor.

Parameters:

geometry - the GeometryDescriptor to pool.

remove

public static final GeometryDescriptor remove(java.lang.String name)

Removes the GeometryDescriptor with the given name from the pool.

Parameters:

name - the name of the GeometryDescriptor to remove.

Returns:

the removed GeometryDescriptor; null if no GeometryDescriptor was found.

size

public static final int size()

Returns the size of the pool.

Returns:

int the count of pooled GeometryDescriptor objects

names

public static final java.util.Set names()

Method names returns a set the keys of the internal poolGeometries map.

Returns:

Set the Set with all names of the currently pooled GeometryDescriptor instances.

clear

public static final void clear()

Clears the pool.

dump

public static final void dump(java.io.PrintStream s)

Dumps the pool to the PrintStream given by the parameter s.

Parameters:

s - the PrintStream to dump the pool to