Package org.jfree.data

Class Range

java.lang.Object
org.jfree.data.Range
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DateRange
public class Range
extends Object
implements Serializable
Represents an immutable range of values.
See Also:
Serialized Form

  • Constructor Summary

    Constructors
    Constructor Description
    Range​(double lower, double upper)
    Creates a new range.

  • Method Summary

    Modifier and Type Method Description
    static Range combine​(Range range1, Range range2)
    Creates a new range by combining two existing ranges.
    double constrain​(double value)
    Returns the value within the range that is closest to the specified value.
    boolean contains​(double value)
    Returns true if the range contains the specified value and false otherwise.
    boolean equals​(Object object)
    Tests this object for equality with an arbitrary object.
    static Range expand​(Range range, double lowerMargin, double upperMargin)
    Creates a new range by adding margins to an existing range.
    double getCentralValue()
    Returns the central value for the range.
    double getLength()
    Returns the length of the range.
    double getLowerBound()
    Returns the lower bound for the range.
    double getUpperBound()
    Returns the upper bound for the range.
    int hashCode()
    Returns a hash code.
    boolean intersects​(double b0, double b1)
    Returns true if the range intersects with the specified range, and false otherwise.
    String toString()
    Returns a string representation of this Range.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Range

      public Range​(double lower, double upper)
      Creates a new range.
      Parameters:
      lower - the lower bound (must be <= upper bound).
      upper - the upper bound (must be >= lower bound).

  • Method Details

    • getLowerBound

      public double getLowerBound()
      Returns the lower bound for the range.
      Returns:
      The lower bound.

    • getUpperBound

      public double getUpperBound()
      Returns the upper bound for the range.
      Returns:
      The upper bound.

    • getLength

      public double getLength()
      Returns the length of the range.
      Returns:
      The length.

    • getCentralValue

      public double getCentralValue()
      Returns the central value for the range.
      Returns:
      The central value.

    • contains

      public boolean contains​(double value)
      Returns true if the range contains the specified value and false otherwise.
      Parameters:
      value - the value to lookup.
      Returns:
      true if the range contains the specified value.

    • intersects

      public boolean intersects​(double b0, double b1)
      Returns true if the range intersects with the specified range, and false otherwise.
      Parameters:
      b0 - the lower bound.
      b1 - the upper bound.
      Returns:
      A boolean.

    • constrain

      public double constrain​(double value)
      Returns the value within the range that is closest to the specified value.
      Parameters:
      value - the value.
      Returns:
      The constrained value.

    • combine

      public static Range combine​(Range range1, Range range2)
      Creates a new range by combining two existing ranges.

      Note that:

      • either range can be null, in which case the other range is returned;
      • if both ranges are null the return value is null.
      Parameters:
      range1 - the first range (null permitted).
      range2 - the second range (null permitted).
      Returns:
      A new range (possibly null).

    • expand

      public static Range expand​(Range range, double lowerMargin, double upperMargin)
      Creates a new range by adding margins to an existing range.
      Parameters:
      range - the range (null not permitted).
      lowerMargin - the lower margin (expressed as a percentage of the range length).
      upperMargin - the upper margin (expressed as a percentage of the range length).
      Returns:
      The expanded range.

    • equals

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

    • hashCode

      public int hashCode()
      Returns a hash code.
      Overrides:
      hashCode in class Object
      Returns:
      A hash code.

    • toString

      public String toString()
      Returns a string representation of this Range.
      Overrides:
      toString in class Object
      Returns:
      A String "Range[lower,upper]" where lower=lower range and upper=upper range.