Package org.jfree.data.time

Class TimePeriodValue

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class TimePeriodValue
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
    Represents a time period and an associated value.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private TimePeriod period
      The time period.
      private static long serialVersionUID
      For serialization.
      private java.lang.Number value
      The value associated with the time period.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Clones the object.
      boolean equals​(java.lang.Object obj)
      Tests this object for equality with the target object.
      TimePeriod getPeriod()
      Returns the time period.
      java.lang.Number getValue()
      Returns the value.
      int hashCode()
      Returns a hash code value for the object.
      void setValue​(java.lang.Number value)
      Sets the value for this data item.
      java.lang.String toString()
      Returns a string representing this instance, primarily for use in debugging.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • serialVersionUID

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

      • period

        private TimePeriod period
        The time period.

      • value

        private java.lang.Number value
        The value associated with the time period.

    • Constructor Detail

      • TimePeriodValue

        public TimePeriodValue​(TimePeriod period,
                       java.lang.Number value)
        Constructs a new data item.
        Parameters:
        period - the time period (null not permitted).
        value - the value associated with the time period.
        Throws:
        java.lang.IllegalArgumentException - if period is null.

      • TimePeriodValue

        public TimePeriodValue​(TimePeriod period,
                       double value)
        Constructs a new data item.
        Parameters:
        period - the time period (null not permitted).
        value - the value associated with the time period.
        Throws:
        java.lang.IllegalArgumentException - if period is null.

    • Method Detail

      • getPeriod

        public TimePeriod getPeriod()
        Returns the time period.
        Returns:
        The time period (never null).

      • getValue

        public java.lang.Number getValue()
        Returns the value.
        Returns:
        The value (possibly null).
        See Also:
        setValue(Number)

      • setValue

        public void setValue​(java.lang.Number value)
        Sets the value for this data item.
        Parameters:
        value - the new value (null permitted).
        See Also:
        getValue()

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this object for equality with the target object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • hashCode

        public int hashCode()
        Returns a hash code value for the object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hashcode

      • clone

        public java.lang.Object clone()
        Clones the object.

        Note: no need to clone the period or value since they are immutable classes.

        Overrides:
        clone in class java.lang.Object
        Returns:
        A clone.

      • toString

        public java.lang.String toString()
        Returns a string representing this instance, primarily for use in debugging.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string.