Module platform

Class FlowKey<K extends Comparable<K>>

java.lang.Object
org.jfree.data.flow.FlowKey<K>
Type Parameters:
K - the type for the keys used to identify sources and destinations (String is a good default choice).
All Implemented Interfaces:
Serializable, Cloneable, PublicCloneable

public class FlowKey<K extends Comparable<K>> extends Object implements PublicCloneable, Serializable
A key that identifies a flow within a dataset.
Since:
1.5.3
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The key for a flow property that, if defined (at the dataset level), contains a Boolean value for the selection status of the flow.
  • Constructor Summary

    Constructors
    Constructor
    Description
    FlowKey(int stage, K source, K destination)
    Creates a new instance.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a clone of the object.
    boolean
    Tests this instance for equality with an arbitrary object.
    Returns the destination identifier.
    Returns the source identifier.
    int
    Returns the stage number for the flow.
    int
    Returns a hashcode for this instance.
    Returns a string representation of this instance, primarily for debugging purposes.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • SELECTED_PROPERTY_KEY

      public static final String SELECTED_PROPERTY_KEY
      The key for a flow property that, if defined (at the dataset level), contains a Boolean value for the selection status of the flow.
      See Also:
  • Constructor Details

    • FlowKey

      public FlowKey(int stage, K source, K destination)
      Creates a new instance.
      Parameters:
      stage - the stage.
      source - the source identifier (null not permitted).
      destination - the destination identifier (null not permitted).
  • Method Details

    • getStage

      public int getStage()
      Returns the stage number for the flow.
      Returns:
      The stage number.
    • getSource

      public K getSource()
      Returns the source identifier.
      Returns:
      The source identifier (never null).
    • getDestination

      public K getDestination()
      Returns the destination identifier.
      Returns:
      The destination identifier (never null).
    • toString

      public String toString()
      Returns a string representation of this instance, primarily for debugging purposes.
      Overrides:
      toString in class Object
      Returns:
      A string.
    • equals

      public boolean equals(Object obj)
      Tests this instance for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.
    • hashCode

      public int hashCode()
      Returns a hashcode for this instance.
      Overrides:
      hashCode in class Object
      Returns:
      A hashcode.
    • clone

      public Object clone() throws CloneNotSupportedException
      Description copied from interface: PublicCloneable
      Returns a clone of the object.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if cloning is not supported for some reason.