org.jfree.chart

Class PaintMap

public class PaintMap extends Object implements Cloneable, Serializable

A storage structure that maps Comparable instances with Paint instances.

To support cloning and serialization, you should only use keys that are cloneable and serializable. Special handling for the Paint instances is included in this class.

Since: 1.0.3

Constructor Summary
PaintMap()
Creates a new (empty) map.
Method Summary
voidclear()
Resets the map to empty.
Objectclone()
Returns a clone of this PaintMap.
booleancontainsKey(Comparable key)
Returns true if the map contains the specified key, and false otherwise.
booleanequals(Object obj)
Tests this map for equality with an arbitrary object.
PaintgetPaint(Comparable key)
Returns the paint associated with the specified key, or null.
voidput(Comparable key, Paint paint)
Adds a mapping between the specified key and paint values.

Constructor Detail

PaintMap

public PaintMap()
Creates a new (empty) map.

Method Detail

clear

public void clear()
Resets the map to empty.

clone

public Object clone()
Returns a clone of this PaintMap.

Returns: A clone of this instance.

Throws: CloneNotSupportedException if any key is not cloneable.

containsKey

public boolean containsKey(Comparable key)
Returns true if the map contains the specified key, and false otherwise.

Parameters: key the key.

Returns: true if the map contains the specified key, and false otherwise.

equals

public boolean equals(Object obj)
Tests this map for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getPaint

public Paint getPaint(Comparable key)
Returns the paint associated with the specified key, or null.

Parameters: key the key (null not permitted).

Returns: The paint, or null.

Throws: IllegalArgumentException if key is null.

put

public void put(Comparable key, Paint paint)
Adds a mapping between the specified key and paint values.

Parameters: key the key (null not permitted). paint the paint.

Throws: IllegalArgumentException if key is null.