g2d.jlambda

Class Attributable

java.lang.Object

g2d.jlambda.Identifiable

g2d.jlambda.Attributable

Direct Known Subclasses:

ClosureAction, ClosureActionListener, ClosureComponentListener, ClosureFilenameFilter, ClosureItemListener, ClosureListSelectionListener, ClosureMouseListener, ClosureMouseMotionListener, ClosureWindowListener, Glyphish, SpawningClosureActionListener

public class Attributable
extends Identifiable

Those things that have Attributes. Attributes are indexed by a String as a key. They contain an Object as the value.

One can set attributes for each object instance or using static attributes that apply to all things Attributable.

Since:

July 11th, 2004

Author:

Ian A. Mason, Linda (get keys, removing attrs, and javadoc), Ian genericized it in January 2007.

Field Summary

Fields inherited from class g2d.jlambda.Identifiable

DEBUG

Constructor Summary

Constructors

Constructor and Description
Attributable() Construct an new Attributable instance.
Attributable(Attributable clone) Construct an Attributable instance by cloning an existing one.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	_getAttribute(java.lang.String key) The final form of getting an attribute.
void	_setAttribute(java.lang.String key, java.lang.Object value) The final form of setting an attribute using the given parameters.
java.lang.Object	getAttribute(java.lang.String key) Get value of given attribute.
boolean	getAttributeAsBoolean(java.lang.String key, boolean defaultValue)
byte	getAttributeAsByte(java.lang.String key, byte defaultValue)
char	getAttributeAsChar(java.lang.String key, char defaultValue)
Closure	getAttributeAsClosure(java.lang.String key, Closure defaultValue)
double	getAttributeAsDouble(java.lang.String key, double defaultValue)
float	getAttributeAsFloat(java.lang.String key, float defaultValue)
int	getAttributeAsInt(java.lang.String key, int defaultValue)
short	getAttributeAsShort(java.lang.String key, short defaultValue)
java.lang.String	getAttributeAsString(java.lang.String key, java.lang.String defaultValue)
java.lang.String[]	getKeys() Obtain all keys of currently set attributes as an array.
java.lang.Object	getStaticAttribute(java.lang.String key) Get value of given static attribute.
java.lang.String[]	getStaticKeys() Obtain all keys of currently set static attributes as an array.
boolean	isAttribute(java.lang.String key) Test whether given key is a valid attribute.
boolean	isStaticAttribute(java.lang.String key) Test whether given key is a valid static attribute.
void	removeAllAttributes() Remove all attributes (that are not static).
void	removeAllStaticAttributes() Remove all static attributes.
void	removeAttribute(java.lang.String key) Remove given attribute.
void	removeStaticAttribute(java.lang.String key) Remove given static attribute.
void	setAttribute(java.lang.String key, java.lang.Object value) Set an attribute using the given parameters.
void	setStaticAttribute(java.lang.String key, java.lang.Object value) Set a static attribute using the given parameters.
void	showAttributes(java.io.PrintStream stream) Dump an attributable object's attributes out to a stream.
void	showAttributes(java.lang.StringBuffer sb)

Methods inherited from class g2d.jlambda.Identifiable

getObject, getUID, setUID, setUID, unsetUID, unsetUID

Methods inherited from class java.lang.Object

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

Constructor Detail

Attributable

public Attributable()

Construct an new Attributable instance.

Attributable

public Attributable(Attributable clone)

Construct an Attributable instance by cloning an existing one.

Parameters:

clone - Attributable instance to be cloned

Method Detail

showAttributes

public void showAttributes(java.io.PrintStream stream)

Dump an attributable object's attributes out to a stream. Make an effort to reveal array contents.

Parameters:

stream - The print stream to absorb the data

showAttributes

public void showAttributes(java.lang.StringBuffer sb)

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

Set an attribute using the given parameters.

Parameters:

key - String of key to identify attribute

value - Object that is value of this attribute

_setAttribute

public final void _setAttribute(java.lang.String key,
                                java.lang.Object value)

The final form of setting an attribute using the given parameters. Used in the interpreter by the setAttr form.

Parameters:

key - String of key to identify attribute

value - Object that is value of this attribute

isAttribute

public boolean isAttribute(java.lang.String key)

Test whether given key is a valid attribute. Note, if attribute with given key was set using null as a value, this will still result in true.

Parameters:

key - String of key to test attribute existence

Returns:

true if attribute with given key has been assigned before, false otherwise

See Also:

setAttribute(java.lang.String, java.lang.Object)

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Get value of given attribute. May return null if attribute does not exist.

Parameters:

key - String of key to obtain attribute

Returns:

Object that is value of given attribute (or null if attribute key does not exist)

_getAttribute

public final java.lang.Object _getAttribute(java.lang.String key)

The final form of getting an attribute. Used in the interpreter by the getAttr form.

Parameters:

key - String of key to identify attribute

Returns:

Object that is value of given attribute (or null if attribute key does not exist)

removeAttribute

public void removeAttribute(java.lang.String key)

Remove given attribute.

Parameters:

key - String of key of attribute to be removed

removeAllAttributes

public void removeAllAttributes()

Remove all attributes (that are not static).

getKeys

public java.lang.String[] getKeys()

Obtain all keys of currently set attributes as an array.

Returns:

String[] of currently known keys of attributes

setStaticAttribute

public void setStaticAttribute(java.lang.String key,
                               java.lang.Object value)

Set a static attribute using the given parameters.

Parameters:

key - String of key to identify static attribute

value - Object that is value of this static attribute

isStaticAttribute

public boolean isStaticAttribute(java.lang.String key)

Test whether given key is a valid static attribute. Note, if static attribute with given key was set using null as a value, this will still result in true.

Parameters:

key - String of key to test static attribute existence

Returns:

true if static attribute with given key has been assigned before, false otherwise

See Also:

setStaticAttribute(java.lang.String, java.lang.Object)

getStaticAttribute

public java.lang.Object getStaticAttribute(java.lang.String key)

Get value of given static attribute. May return null if static attribute does not exist.

Parameters:

key - String of key to obtain static attribute

Returns:

Object that is value of given static attribute (or null if attribute key does not exist)

removeStaticAttribute

public void removeStaticAttribute(java.lang.String key)

Remove given static attribute.

Parameters:

key - String of key of static attribute to be removed

removeAllStaticAttributes

public void removeAllStaticAttributes()

Remove all static attributes.

getStaticKeys

public java.lang.String[] getStaticKeys()

Obtain all keys of currently set static attributes as an array.

Returns:

String[] of currently known keys of static attributes

getAttributeAsByte

public byte getAttributeAsByte(java.lang.String key,
                               byte defaultValue)

getAttributeAsBoolean

public boolean getAttributeAsBoolean(java.lang.String key,
                                     boolean defaultValue)

getAttributeAsChar

public char getAttributeAsChar(java.lang.String key,
                               char defaultValue)

getAttributeAsDouble

public double getAttributeAsDouble(java.lang.String key,
                                   double defaultValue)

getAttributeAsFloat

public float getAttributeAsFloat(java.lang.String key,
                                 float defaultValue)

getAttributeAsInt

public int getAttributeAsInt(java.lang.String key,
                             int defaultValue)

getAttributeAsShort

public short getAttributeAsShort(java.lang.String key,
                                 short defaultValue)

getAttributeAsString

public java.lang.String getAttributeAsString(java.lang.String key,
                                             java.lang.String defaultValue)

getAttributeAsClosure

public Closure getAttributeAsClosure(java.lang.String key,
                                     Closure defaultValue)