Package org.opentrafficsim.animation.graphs

Record Class AbstractContourPlot.LabelData<Z extends Number>

java.lang.Object
java.lang.Record
org.opentrafficsim.animation.graphs.AbstractContourPlot.LabelData<Z>
Type Parameters:
Z - value type
Record Components:
legendStep - increment between color legend entries
legendFormat - format string for the captions in the color legend, for example %.1fm/s for 30.2m/s
labelFormat - format string used to create status label (under the mouse), e.g. desired speed %.1f m/s
Enclosing class:
AbstractContourPlot<Z extends Number>
public static record AbstractContourPlot.LabelData<Z extends Number>(Z extends Number legendStep, String legendFormat, String labelFormat) extends Record
Input container for label input.

  • Constructor Details

    • LabelData

      public LabelData(Z legendStep, String legendFormat, String labelFormat)
      Creates an instance of a LabelData record class.
      Parameters:
      legendStep - the value for the legendStep record component
      legendFormat - the value for the legendFormat record component
      labelFormat - the value for the labelFormat record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • legendStep

      public Z legendStep()
      Returns the value of the legendStep record component.
      Returns:
      the value of the legendStep record component

    • legendFormat

      public String legendFormat()
      Returns the value of the legendFormat record component.
      Returns:
      the value of the legendFormat record component

    • labelFormat

      public String labelFormat()
      Returns the value of the labelFormat record component.
      Returns:
      the value of the labelFormat record component