public class

PaintMap

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.PaintMap

Class Overview

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.

Summary

Public Constructors
PaintMap()
Creates a new (empty) map.
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PaintMap ()

Creates a new (empty) map.

Public Methods

public void clear ()

Resets the map to empty.

public Object clone ()

Returns a clone of this PaintMap.

Returns
  • A clone of this instance.
Throws
CloneNotSupportedException if any key is not cloneable.

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.

public boolean equals (Object obj)

Tests this map for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

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.

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.