Class MeterInterval

  • All Implemented Interfaces:
    java.io.Serializable

    public class MeterInterval
    extends java.lang.Object
    implements java.io.Serializable
    An interval to be highlighted on a MeterPlot. Instances of this class are immutable.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.awt.Paint backgroundPaint
      The background paint for the interval.
      private java.lang.String label
      The interval label.
      private java.awt.Paint outlinePaint
      The outline paint (used for the arc marking the interval).
      private java.awt.Stroke outlineStroke
      The outline stroke (used for the arc marking the interval).
      private Range range
      The interval range.
      private static long serialVersionUID
      For serialization.
    • Constructor Summary

      Constructors 
      Constructor Description
      MeterInterval​(java.lang.String label, Range range)
      Creates a new interval.
      MeterInterval​(java.lang.String label, Range range, java.awt.Paint outlinePaint, java.awt.Stroke outlineStroke, java.awt.Paint backgroundPaint)
      Creates a new interval.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Checks this instance for equality with an arbitrary object.
      java.awt.Paint getBackgroundPaint()
      Returns the background paint.
      java.lang.String getLabel()
      Returns the label.
      java.awt.Paint getOutlinePaint()
      Returns the outline paint.
      java.awt.Stroke getOutlineStroke()
      Returns the outline stroke.
      Range getRange()
      Returns the range.
      private void readObject​(java.io.ObjectInputStream stream)
      Provides serialization support.
      private void writeObject​(java.io.ObjectOutputStream stream)
      Provides serialization support.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values
      • label

        private java.lang.String label
        The interval label.
      • range

        private Range range
        The interval range.
      • outlinePaint

        private transient java.awt.Paint outlinePaint
        The outline paint (used for the arc marking the interval).
      • outlineStroke

        private transient java.awt.Stroke outlineStroke
        The outline stroke (used for the arc marking the interval).
      • backgroundPaint

        private transient java.awt.Paint backgroundPaint
        The background paint for the interval.
    • Constructor Detail

      • MeterInterval

        public MeterInterval​(java.lang.String label,
                             Range range)
        Creates a new interval.
        Parameters:
        label - the label (null not permitted).
        range - the range (null not permitted).
      • MeterInterval

        public MeterInterval​(java.lang.String label,
                             Range range,
                             java.awt.Paint outlinePaint,
                             java.awt.Stroke outlineStroke,
                             java.awt.Paint backgroundPaint)
        Creates a new interval.
        Parameters:
        label - the label (null not permitted).
        range - the range (null not permitted).
        outlinePaint - the outline paint (null permitted).
        outlineStroke - the outline stroke (null permitted).
        backgroundPaint - the background paint (null permitted).
    • Method Detail

      • getLabel

        public java.lang.String getLabel()
        Returns the label.
        Returns:
        The label (never null).
      • getRange

        public Range getRange()
        Returns the range.
        Returns:
        The range (never null).
      • getBackgroundPaint

        public java.awt.Paint getBackgroundPaint()
        Returns the background paint. If null, the background should remain unfilled.
        Returns:
        The background paint (possibly null).
      • getOutlinePaint

        public java.awt.Paint getOutlinePaint()
        Returns the outline paint.
        Returns:
        The outline paint (possibly null).
      • getOutlineStroke

        public java.awt.Stroke getOutlineStroke()
        Returns the outline stroke.
        Returns:
        The outline stroke (possibly null).
      • equals

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

        private void writeObject​(java.io.ObjectOutputStream stream)
                          throws java.io.IOException
        Provides serialization support.
        Parameters:
        stream - the output stream.
        Throws:
        java.io.IOException - if there is an I/O error.
      • readObject

        private void readObject​(java.io.ObjectInputStream stream)
                         throws java.io.IOException,
                                java.lang.ClassNotFoundException
        Provides serialization support.
        Parameters:
        stream - the input stream.
        Throws:
        java.io.IOException - if there is an I/O error.
        java.lang.ClassNotFoundException - if there is a classpath problem.