com.tensegrity.composite.style
Class StylePool

java.lang.Object
  com.tensegrity.composite.style.StylePool

public class StylePool

extends java.lang.Object

This class is a pool for StyleDescriptor instances.

Version:

$Id: StylePool.java,v 1.23 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 StyleDescriptor	get(java.lang.String name) Returns the instance of the StyleDescriptor with the given name if any.
static boolean	isAvailable(java.lang.String name) Returns a boolean that indicates whether a StyleDescriptor 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 poolStyles map.
static void	pool(StyleDescriptor style) Adds the given StyleDescriptor to the list of pooled descriptors.
static StyleDescriptor	remove(java.lang.String name) Removes the StyleDescriptor with the given name from the pool.
static int	size() Returns the number of StyleDescriptors in the pool.
static void	useThreadLocal() A call to this method configures the StylePool to make use of the ThreadLocal class hence a pool is created for each Thread the StylePool 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 StylePool to make use of the ThreadLocal class hence a pool is created for each Thread the StylePool is used by.
Notice: This configuration must be done before the StylePool 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 StyleDescriptor with the name given by name is in the pool or not.

Parameters:

name - the mame of the StyleDescriptor to check

Returns:

boolean flag that indicates whether a StyleDescriptor with the given name is avaiable or not

pool

public static final void pool(StyleDescriptor style)

Adds the given StyleDescriptor to the list of pooled descriptors. To retrieve pooled instance via the get-method, use the name of the StyleDescriptor.

Parameters:

style - the GeometryDescriptor to pool.

get

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

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

Parameters:

name - the mame of the StyleDescriptor to retrieve.

Returns:

the StyleDescriptor with the given name; null if there is no such pooled item.

remove

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

Removes the StyleDescriptor with the given name from the pool.

Parameters:

name - the name of the StyleDescriptor to remove.

Returns:

the removed StyleDescriptor; null if no StyleDescriptor was found.

size

public static final int size()

Returns the number of StyleDescriptors in the pool.

Returns:

the count of pooled StyleDescriptor objects.

names

public static final java.util.Set names()

Method names returns a set the keys of the internal poolStyles 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