Bounds (JSimpleDB Utility Classes 2.1.7 API)

java.lang.Object
- org.jsimpledb.util.Bounds<T>

Type Parameters:
T - Java type of range bounds
```
public class Bounds<T>
extends Object
```
Utility class used by AbstractNavigableSet and AbstractNavigableMap to define the (optional) upper and lower bounds of a restricted range.

Constructor Summary

Constructors
Constructor and Description
`Bounds()` Convenience constructor to create a new instance with no upper or lower bounds.
`Bounds(T bound, BoundType boundType, boolean upper)` Create a one-sided bound.
`Bounds(T lowerBound, BoundType lowerBoundType, T upperBound, BoundType upperBoundType)` Primary constructor.
`Bounds(T lowerBound, T upperBound)` Create two-sided bounds with inclusive lower bound and exclusive upper bound.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`T`	`getLowerBound()` Get the Java value corresponding to the lower bound restriction, if any.
`BoundType`	`getLowerBoundType()` Get the type of the lower bound that corresponds to `getLowerBound()`.
`T`	`getUpperBound()` Get the Java value corresponding to the upper bound restriction, if any.
`BoundType`	`getUpperBoundType()` Get the type of the upper bound that corresponds to `getUpperBound()`.
`int`	`hashCode()`
`boolean`	`isWithinBounds(Comparator<? super T> comparator, Bounds<? extends T> newBounds)` Determine whether the given new `Bounds` is within of the bounds of this instance.
`boolean`	`isWithinBounds(Comparator<? super T> comparator, T value)` Check whether the given value is within the bounds of this instance.
`boolean`	`isWithinLowerBound(Comparator<? super T> comparator, T value)` Check whether the given value is within the lower bound of this instance.
`boolean`	`isWithinUpperBound(Comparator<? super T> comparator, T value)` Check whether the given value is within the upper bound of this instance.
`Bounds<T>`	`reverse()` Create an instance like this instance but with the upper and lower bounds reversed.
`String`	`toString()`
`Bounds<T>`	`withLowerBound(T newLowerBound, BoundType newLowerBoundType)` Create an instance like this instance but with a different lower bound.
`Bounds<T>`	`withoutLowerBound()` Create an instance like this instance but with the lower bound removed.
`Bounds<T>`	`withoutUpperBound()` Create an instance like this instance but with the upper bound removed.
`Bounds<T>`	`withUpperBound(T newUpperBound, BoundType newUpperBoundType)` Create an instance like this instance but with a different upper bound.

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

- Constructor Detail
  - Bounds
```
public Bounds()
```
    Convenience constructor to create a new instance with no upper or lower bounds.
  - Bounds
```
public Bounds(T bound,
      BoundType boundType,
      boolean upper)
```
    Create a one-sided bound.
    
    Parameters:
    bound - bound restriction value; ignored if boundType is BoundType.NONE
    boundType - type of bound for bound, or BoundType.NONE if there is no lower bound
    upper - true to create an upper bound, false to create a lower bound
    
    Throws:
    
    IllegalArgumentException - if boundType is null
  - Bounds
```
public Bounds(T lowerBound,
      T upperBound)
```
    Create two-sided bounds with inclusive lower bound and exclusive upper bound.
    
    Parameters:
    lowerBound - lower bound restriction value (inclusive)
    upperBound - upper bound restriction value (exclusive)
  - Bounds
```
public Bounds(T lowerBound,
      BoundType lowerBoundType,
      T upperBound,
      BoundType upperBoundType)
```
    Primary constructor.
    
    Parameters:
    lowerBound - lower bound restriction value; ignored if lowerBoundType is BoundType.NONE
    lowerBoundType - type of bound for lowerBound, or BoundType.NONE if there is no lower bound
    upperBound - upper bound restriction value; ignored if upperBoundType is BoundType.NONE
    upperBoundType - type of bound for upperBound, or BoundType.NONE if there is no upper bound
    
    Throws:
    
    IllegalArgumentException - if lowerBoundType or upperBoundType is null
- Method Detail
  - getLowerBound
```
public T getLowerBound()
```
    Get the Java value corresponding to the lower bound restriction, if any. Returns null when getLowerBoundType() returns BoundType.NONE.
    
    Returns:
    lower bound Java value, or null if there is no lower bound
  - getUpperBound
```
public T getUpperBound()
```
    Get the Java value corresponding to the upper bound restriction, if any. Returns null when getUpperBoundType() returns BoundType.NONE.
    
    Returns:
    upper bound Java value, or null if there is no upper bound
  - getLowerBoundType
```
public BoundType getLowerBoundType()
```
    Get the type of the lower bound that corresponds to getLowerBound().
    
    Returns:
    lower bound restriction type, never null
  - getUpperBoundType
```
public BoundType getUpperBoundType()
```
    Get the type of the upper bound that corresponds to getUpperBound().
    
    Returns:
    upper bound restriction type, never null
  - reverse
```
public Bounds<T> reverse()
```
    Create an instance like this instance but with the upper and lower bounds reversed. Obviously, the result is only sensible when a reversed Comparator is also used.
    
    Returns:
    reversal of this instance
  - withLowerBound
```
public Bounds<T> withLowerBound(T newLowerBound,
                       BoundType newLowerBoundType)
```
    Create an instance like this instance but with a different lower bound.
    
    Parameters:
    newLowerBound - new lower bound restriction value; ignored if newLowerBoundType is BoundType.NONE
    newLowerBoundType - type of bound for newLowerBound, or BoundType.NONE if there is no lower bound
    
    Returns:
    instance with new lower bound
    
    Throws:
    
    IllegalArgumentException - if newLowerBoundType is null
  - withUpperBound
```
public Bounds<T> withUpperBound(T newUpperBound,
                       BoundType newUpperBoundType)
```
    Create an instance like this instance but with a different upper bound.
    
    Parameters:
    newUpperBound - new upper bound restriction value; ignored if newUpperBoundType is BoundType.NONE
    newUpperBoundType - type of bound for newUpperBound, or BoundType.NONE if there is no upper bound
    
    Returns:
    instance with new upper bound
    
    Throws:
    
    IllegalArgumentException - if newUpperBoundType is null
  - withoutLowerBound
```
public Bounds<T> withoutLowerBound()
```
    Create an instance like this instance but with the lower bound removed.
    
    Returns:
    new instance
  - withoutUpperBound
```
public Bounds<T> withoutUpperBound()
```
    Create an instance like this instance but with the upper bound removed.
    
    Returns:
    new instance
  - isWithinLowerBound
```
public boolean isWithinLowerBound(Comparator<? super T> comparator,
                         T value)
```
    Check whether the given value is within the lower bound of this instance.
    
    Parameters:
    comparator - comparator used to compare values, or null for natural ordering
    value - value to check
    
    Returns:
    true if value is within bounds, false otherwise
  - isWithinUpperBound
```
public boolean isWithinUpperBound(Comparator<? super T> comparator,
                         T value)
```
    Check whether the given value is within the upper bound of this instance.
    
    Parameters:
    comparator - comparator used to compare values, or null for natural ordering
    value - value to check
    
    Returns:
    true if value is within bounds, false otherwise
  - isWithinBounds
```
public boolean isWithinBounds(Comparator<? super T> comparator,
                     T value)
```
    Check whether the given value is within the bounds of this instance.
    Equivalent to:
    isWithinLowerBound(comparator, value) && isWithinUpperBound(comparator, value)
    
    Parameters:
    comparator - comparator used to compare values, or null for natural ordering
    value - value to check
    
    Returns:
    true if value is within bounds, false otherwise
  - isWithinBounds
```
public boolean isWithinBounds(Comparator<? super T> comparator,
                     Bounds<? extends T> newBounds)
```
    Determine whether the given new Bounds is within of the bounds of this instance.
    
    Parameters:
    comparator - comparator used to compare values, or null for natural ordering
    newBounds - new bounds
    
    Returns:
    true if newBounds is in range, false otherwise
    
    Throws:
    
    IllegalArgumentException - if newBounds is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Bounds<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bounds

Bounds

Bounds

Bounds

Method Detail

getLowerBound

getUpperBound

getLowerBoundType

getUpperBoundType

reverse

withLowerBound

withUpperBound

withoutLowerBound

withoutUpperBound

isWithinLowerBound

isWithinUpperBound

isWithinBounds

isWithinBounds

toString

equals

hashCode