org.apache.commons.lang3.DoubleRange

All Implemented Interfaces:: Serializable

public final class DoubleRange extends NumberRange<Double>

Specializes NumberRange for Doubles.

This class is not designed to interoperate with other NumberRanges

Since:

3.13.0

See Also:

Method Summary

Modifier and Type

Method

Description

double

fit(double element)

Fits the given value into this range by returning the given value or, if out of bounds, the range minimum if below, or the range maximum if above.

static DoubleRange

of(double fromInclusive, double toInclusive)

Creates a range with the specified minimum and maximum values (both inclusive).

static DoubleRange

of(Double fromInclusive, Double toInclusive)

Creates a range with the specified minimum and maximum values (both inclusive).

Methods inherited from class Range
between, between, contains, containsRange, elementCompareTo, equals, fit, getComparator, getMaximum, getMinimum, hashCode, intersectionWith, is, is, isAfter, isAfterRange, isBefore, isBeforeRange, isEndedBy, isNaturalOrdering, isOverlappedBy, isStartedBy, of, of, toString, toString

Modifier and Type

Method

Description

static <T extends Comparable<? super T>> Range<T>

between(T fromInclusive, T toInclusive)

Deprecated.
Use Range.of(Comparable, Comparable).

static <T> Range<T>

between(T fromInclusive, T toInclusive, Comparator<T> comparator)

Deprecated.
Use Range.of(Object, Object, Comparator).

boolean

contains(Double element)

Checks whether the specified element occurs within this range.

boolean

containsRange(Range<Double> otherRange)

Checks whether this range contains all the elements of the specified range.

int

elementCompareTo(Double element)

Checks where the specified element occurs relative to this range.

boolean

equals(Object obj)

Compares this range to another object to test if they are equal.

Double

fit(Double element)

Fits the given element into this range by returning the given element or, if out of bounds, the range minimum if below, or the range maximum if above.

Comparator<Double>

getComparator()

Gets the comparator being used to determine if objects are within the range.

Double

getMaximum()

Gets the maximum value in this range.

Double

getMinimum()

Gets the minimum value in this range.

int

hashCode()

Gets a suitable hash code for the range.

Range<Double>

intersectionWith(Range<Double> other)

Calculate the intersection of this and an overlapping Range.

static <T extends Comparable<? super T>> Range<T>

is(T element)

Creates a range using the specified element as both the minimum and maximum in this range.

static <T> Range<T>

is(T element, Comparator<T> comparator)

Creates a range using the specified element as both the minimum and maximum in this range.

boolean

isAfter(Double element)

Tests whether this range is after the specified element.

boolean

isAfterRange(Range<Double> otherRange)

Tests whether this range is completely after the specified range.

boolean

isBefore(Double element)

Tests whether this range is before the specified element.

boolean

isBeforeRange(Range<Double> otherRange)

Tests whether this range is completely before the specified range.

boolean

isEndedBy(Double element)

Tests whether this range ends with the specified element.

boolean

isNaturalOrdering()

Tests whether or not the Range is using the natural ordering of the elements.

boolean

isOverlappedBy(Range<Double> otherRange)

Tests whether this range is overlapped by the specified range.

boolean

isStartedBy(Double element)

Tests whether this range starts with the specified element.

static <T extends Comparable<? super T>> Range<T>

of(T fromInclusive, T toInclusive)

Creates a range with the specified minimum and maximum values (both inclusive).

static <T> Range<T>

of(T fromInclusive, T toInclusive, Comparator<T> comparator)

Creates a range with the specified minimum and maximum values (both inclusive).

String

toString()

Gets the range as a String.

String

toString(String format)

Formats the receiver using the given format.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details
- of
  
  public static DoubleRange of(double fromInclusive, double toInclusive)
  
  Creates a range with the specified minimum and maximum values (both inclusive).
  The range uses the natural ordering of the elements to determine where values lie in the range.
  
  The arguments may be passed in the order (min, max) or (max,min). The getMinimum and getMaximum methods will return the correct values.
  
  Parameters:
  
  fromInclusive - The first value that defines the edge of the range, inclusive.
  
  toInclusive - The second value that defines the edge of the range, inclusive.
  
  Returns:
  
  The range object, not null.
  
  Throws:
  
  IllegalArgumentException - Thrown if either value is NaN.
- of
  
  public static DoubleRange of(Double fromInclusive, Double toInclusive)
  
  Creates a range with the specified minimum and maximum values (both inclusive).
  The range uses the natural ordering of the elements to determine where values lie in the range.
  
  The arguments may be passed in the order (min, max) or (max,min). The getMinimum and getMaximum methods will return the correct values.
  
  Parameters:
  
  fromInclusive - The first value that defines the edge of the range, inclusive.
  
  toInclusive - The second value that defines the edge of the range, inclusive.
  
  Returns:
  
  The range object, not null.
  
  Throws:
  
  NullPointerException - Thrown if either element is null.
  
  IllegalArgumentException - Thrown if either element is NaN.
- fit
  public double fit(double element)
  
  Fits the given value into this range by returning the given value or, if out of bounds, the range minimum if below, or the range maximum if above.
  LongRange range = LongRange.of(16, 64); range.fit(-9) --> 16 range.fit(0) --> 16 range.fit(15) --> 16 range.fit(16) --> 16 range.fit(17) --> 17 ... range.fit(63) --> 63 range.fit(64) --> 64 range.fit(99) --> 64
  
  Parameters:
  
  element - The element to test.
  
  Returns:
  
  The minimum, the element, or the maximum depending on the element's location relative to the range.
  
  Since:
  
  3.19.0

Class DoubleRange

Method Summary

Methods inherited from class Range

Methods inherited from class Object

Method Details

of

of

fit