Package org.jfree.chart.entity

Class FlowEntity

java.lang.Object

org.jfree.chart.entity.ChartEntity

org.jfree.chart.entity.FlowEntity

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable

public class FlowEntity
extends ChartEntity

A chart entity representing the flow between two nodes in a FlowPlot.

Since:

1.5.3

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FlowEntity(FlowKey key, Shape area, String toolTipText, String urlText)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	canEqual(Object other)	Ensures symmetry between super/subclass implementations of equals.
boolean	equals(Object obj)	Tests this instance for equality with an arbitrary object.
FlowKey	getKey()	Returns the key identifying the flow.
int	hashCode()	Returns a hash code for this instance.
String	toString()	Returns a string representation of this instance, primarily for debugging purposes.

Methods inherited from class org.jfree.chart.entity.ChartEntity

clone, getArea, getImageMapAreaTag, getShapeCoords, getShapeType, getToolTipText, getURLText, setArea, setToolTipText, setURLText

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FlowEntity

public FlowEntity(FlowKey key,
 Shape area,
 String toolTipText,
 String urlText)

Creates a new instance.

Parameters:

key - the key identifying the flow (null not permitted).

area - the outline of the entity (null not permitted).

toolTipText - the tool tip text.

urlText - the URL text.

Method Details

getKey

public FlowKey getKey()

Returns the key identifying the flow.

Returns:

The flow key (never null).

toString

public String toString()

Returns a string representation of this instance, primarily for debugging purposes.

Overrides:

toString in class ChartEntity

Returns:

A string.

equals

public boolean equals(Object obj)

Tests this instance for equality with an arbitrary object.

Overrides:

equals in class ChartEntity

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

canEqual

public boolean canEqual(Object other)

Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.

Overrides:

canEqual in class ChartEntity

Parameters:

other - Object

Returns:

true ONLY if the parameter is THIS class type

hashCode

public int hashCode()

Description copied from class: ChartEntity

Returns a hash code for this instance.

Overrides:

hashCode in class ChartEntity

Returns:

A hash code.