Class StandardFlowLabelGenerator

java.lang.Object
org.jfree.chart.labels.StandardFlowLabelGenerator
All Implemented Interfaces:
Serializable, FlowLabelGenerator

Standard flow label generator. Instances of this class are immutable.
Since:
1.5.3
See Also:
  • Field Details

  • Constructor Details

    • StandardFlowLabelGenerator

      Creates a new instance with the default template.
    • StandardFlowLabelGenerator

      Creates a new generator with the specified template. The template is passed to a Java Formatter instance along with four arguments, the stage (an integer), the source (a String), the destination (a String) and the flow value (a Number).
      Parameters:
      template - the template (null not permitted).
  • Method Details

    • generateLabel

      public String generateLabel(FlowDataset dataset, FlowKey key)
      Returns a label for the specified flow.
      Specified by:
      generateLabel in interface FlowLabelGenerator
      Parameters:
      dataset - the flow dataset (null not permitted).
      key - the flow key (null not permitted).
      Returns:
      The label (possibly null).
    • equals

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

      public int hashCode()
      Overrides:
      hashCode in class Object