Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.entity

Class StandardEntityCollection

Implemented Interfaces:
Cloneable, EntityCollection, PublicCloneable, Serializable
public class StandardEntityCollection
extends java.lang.Object
implements EntityCollection, Cloneable, PublicCloneable, Serializable
A standard implementation of the EntityCollection interface.

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
clear()
Clears all the entities from the collection.
Object
clone()
Returns a clone of this entity collection.
boolean
equals(Object obj)
Tests this object for equality with an arbitrary object.
Collection
getEntities()
Returns the entities in an unmodifiable collection.
ChartEntity
getEntity(double x, double y)
Returns the last entity in the list with an area that encloses the specified coordinates, or null if there is no such entity.
ChartEntity
getEntity(int index)
Returns a chart entity from the collection.
int
getEntityCount()
Returns the number of entities in the collection.
Iterator
iterator()
Returns an iterator for the entities in the collection.

Constructor Details

StandardEntityCollection

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

Method Details

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 (null not permitted).

clear

public void clear()
Clears all the entities from the collection.
Specified by:
clear in interface EntityCollection

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this entity collection.
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
Parameters:
obj - the object to test against (null permitted).
Returns:
A boolean.

getEntities

public Collection getEntities()
Returns the entities in an unmodifiable collection.
Specified by:
getEntities in interface EntityCollection
Returns:
The entities.

getEntity

public ChartEntity getEntity(double x,
                             double y)
Returns the last entity in the list with an area that encloses the specified coordinates, or null if there is no such entity.
Specified by:
getEntity in interface EntityCollection
Parameters:
x - the x coordinate.
y - the y coordinate.
Returns:
The entity (possibly null).

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.
See Also:
add(ChartEntity)

getEntityCount

public int getEntityCount()
Returns the number of entities in the collection.
Specified by:
getEntityCount in interface EntityCollection
Returns:
The entity count.

iterator

public Iterator iterator()
Returns an iterator for the entities in the collection.
Specified by:
iterator in interface EntityCollection
Returns:
An iterator.

Overview Package Class Use Source Tree Index Deprecated About