org.jfree.chart.entity
Class StandardEntityCollection

java.lang.Object
  extended byorg.jfree.chart.entity.StandardEntityCollection
All Implemented Interfaces:
java.lang.Cloneable, EntityCollection, java.io.Serializable

public class StandardEntityCollection
extends java.lang.Object
implements EntityCollection, java.lang.Cloneable, java.io.Serializable

A standard implementation of the EntityCollection interface.

See Also:
Serialized Form

Constructor Summary
StandardEntityCollection()
          Constructs a new entity collection (initially empty).
 
Method Summary
 void add(ChartEntity entity)
          Adds an entity to the collection.
 void addAll(EntityCollection collection)
          Adds all the entities from the specified collection.
 void addEntities(EntityCollection collection)
          Adds all the entities from the specified collection.
 void addEntity(ChartEntity entity)
          Adds an entity.
 void clear()
          Clears the entities.
 java.lang.Object clone()
          Returns a clone.
 boolean equals(java.lang.Object obj)
          Tests this object for equality with an arbitrary object.
 java.util.Collection getEntities()
          Returns the entities in an unmodifiable collection.
 ChartEntity getEntity(double x, double y)
          Returns an entity for the specified coordinates.
 ChartEntity getEntity(int index)
          Returns a chart entity from the collection.
 int getEntityCount()
          Returns the number of entities in the collection.
 java.util.Iterator iterator()
          Returns an iterator for the entities in the collection.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardEntityCollection

public StandardEntityCollection()
Constructs a new entity collection (initially empty).

Method Detail

getEntityCount

public int getEntityCount()
Returns the number of entities in the collection.

Specified by:
getEntityCount in interface EntityCollection
Returns:
The entity count.

getEntity

public ChartEntity getEntity(int index)
Returns a chart entity from the collection.

Specified by:
getEntity in interface EntityCollection
Parameters:
index - the entity index.
Returns:
The entity.

clear

public void clear()
Clears the entities.

Specified by:
clear in interface EntityCollection

add

public void add(ChartEntity entity)
Adds an entity to the collection.

Specified by:
add in interface EntityCollection
Parameters:
entity - the entity (null not permitted).

addAll

public void addAll(EntityCollection collection)
Adds all the entities from the specified collection.

Specified by:
addAll in interface EntityCollection
Parameters:
collection - the collection of entities.

getEntity

public ChartEntity getEntity(double x,
                             double y)
Returns an entity for the specified coordinates.

Specified by:
getEntity in interface EntityCollection
Parameters:
x - the x coordinate.
y - the y coordinate.
Returns:
the entity.

getEntities

public java.util.Collection getEntities()
Returns the entities in an unmodifiable collection.

Specified by:
getEntities in interface EntityCollection
Returns:
The entities.

iterator

public java.util.Iterator iterator()
Returns an iterator for the entities in the collection.

Specified by:
iterator in interface EntityCollection
Returns:
An iterator.

equals

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

Parameters:
obj - the object to test against (null permitted).
Returns:
A boolean.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone.

Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - if the object cannot be cloned.

addEntity

public void addEntity(ChartEntity entity)
Adds an entity.

Parameters:
entity - the entity.

addEntities

public void addEntities(EntityCollection collection)
Adds all the entities from the specified collection.

Parameters:
collection - the collection of entities.