org.jfree.chart

Class PaintMap

Implemented Interfaces:
Cloneable, Serializable

public class PaintMap
extends java.lang.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

void
clear()
Resets the map to empty.
Object
clone()
Returns a clone of this PaintMap.
boolean
containsKey(Comparable key)
Returns true if the map contains the specified key, and false otherwise.
boolean
equals(Object obj)
Tests this map for equality with an arbitrary object.
Paint
getPaint(Comparable key)
Returns the paint associated with the specified key, or null.
void
put(Comparable key, Paint paint)
Adds a mapping between the specified key and paint values.

Constructor Details

PaintMap

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

Method Details

clear

public void clear()
Resets the map to empty.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this PaintMap.
Returns:
A clone of this instance.

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.

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.