ca.quine.jcommons.transform
Class GlobalProperties

java.lang.Object
  |
  +--ca.quine.jcommons.transform.GlobalProperties

public class GlobalProperties

extends Object

Provides a non-type safe generic way of setting and accessing global properties for transforms. Users are not required to use this class for global properties, but those wishing to write transforms that can easily be reused should strongly consider it.

If type safety is required, the author recommends creating a Singleton that is similar in nature to this one that is more specific to the task at hand.

Recommendations:

• Keys should be Strings and start with the fully qualified class name of the transform class (i.e. "com.example.FooTransform.myProperty"). This way, key conflicts between different software providers are eliminated.
• Keys should be defined as public static final fields on the transform class that uses them (i.e.

  public static final String MY_PROPERTY = "com.example.FooTransform.myProperty";

  ). Users of the transform class can then be assured the key is correct and their editor can provide code completion.

See Also:

ThreadProperties

Method Summary

static GlobalProperties	getInstance()
Object	getProperty(Object key)
Object	removeProperty(Object key)
void	setProperty(Object key, Object value)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static GlobalProperties getInstance()

setProperty

public void setProperty(Object key,
                        Object value)

getProperty

public Object getProperty(Object key)

removeProperty

public Object removeProperty(Object key)