com.jidesoft.range
Class BigDecimalRange

java.lang.Object
  com.jidesoft.range.AbstractRange<BigDecimal>
      com.jidesoft.range.BigDecimalRange

All Implemented Interfaces:

Range<BigDecimal>, Comparable<Range>

public class BigDecimalRange
extends AbstractRange<BigDecimal>

Specifies upper and lower bounds for a range of values

Field Summary

protected BigDecimal	_max
protected BigDecimal	_min

Fields inherited from interface com.jidesoft.range.Range

PROPERTY_MAX, PROPERTY_MIN

Constructor Summary

BigDecimalRange()
Creates a numeric range with minimum 0.0 and maximum of 1.0

BigDecimalRange(BigDecimal min, BigDecimal max)
Create a numeric range by supplying minimum and maximum values

BigDecimalRange(BigDecimalRange BigDecimalRange)
Creates a copy of the supplied BigDecimalRange

Method Summary

void	adjust(BigDecimal lower, BigDecimal upper) Adjusts the range.
boolean	contains(BigDecimal x) Determines whether the supplied point lies within this range.
Range<BigDecimal>	copy()
Range<BigDecimal>	createIntermediate(Range<BigDecimal> target, double position)
boolean	equals(Object other) Test for equality based on the values of min and max
BigDecimal	getMax()
BigDecimal	getMin()
int	hashCode()
BigDecimal	lower()
double	maximum() This may be the numeric representation of upper() or it may be rounded up.
double	minimum() This may be the numeric representation of lower() or it may be rounded down.
void	setMax(BigDecimal max) Sets the maximum value
void	setMin(BigDecimal min) Sets the minimum value
double	size() Compute the size of the range
BigDecimalRange	stretch(double stretchFactor) Creates a new BigDecimalRange by enlarging this numeric range about its mid-point.
BigDecimalRange	stretch(double stretchFactorForLower, double stretchFactorForUpper) Creates a new BigDecimalRange by enlarging this numeric range about its mid-point.
String	toString()
BigDecimal	upper()

Methods inherited from class com.jidesoft.range.AbstractRange

addPropertyChangeListener, compareTo, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

_min

protected BigDecimal _min

_max

protected BigDecimal _max

Constructor Detail

BigDecimalRange

public BigDecimalRange()

Creates a numeric range with minimum 0.0 and maximum of 1.0

BigDecimalRange

public BigDecimalRange(BigDecimal min,
                       BigDecimal max)

Create a numeric range by supplying minimum and maximum values

Parameters:

min - the minimum

max - the maximum

BigDecimalRange

public BigDecimalRange(BigDecimalRange BigDecimalRange)

Creates a copy of the supplied BigDecimalRange

Parameters:

BigDecimalRange - the BigDecimalRange instance to copy

Method Detail

copy

public Range<BigDecimal> copy()

Overrides:

copy in class AbstractRange<BigDecimal>

minimum

public double minimum()

Description copied from interface: Range

This may be the numeric representation of lower() or it may be rounded down.

Returns:

the minimum value

maximum

public double maximum()

Description copied from interface: Range

This may be the numeric representation of upper() or it may be rounded up.

Returns:

the maximum value

getMin

public BigDecimal getMin()

Returns:

the minimum value

setMin

public void setMin(BigDecimal min)

Sets the minimum value

Parameters:

min - the new minimum value.

getMax

public BigDecimal getMax()

Returns:

the maximum value

setMax

public void setMax(BigDecimal max)

Sets the maximum value

Parameters:

max - the new maximum value.

size

public double size()

Description copied from interface: Range

Compute the size of the range

Returns:

the size of the range

lower

public BigDecimal lower()

Returns:

the minimum() value for the range

adjust

public void adjust(BigDecimal lower,
                   BigDecimal upper)

Description copied from interface: Range

Adjusts the range.

Parameters:

lower - the new smallest value of the range

upper - the new largest value of the range

upper

public BigDecimal upper()

Returns:

the maximum() value for the range

contains

public boolean contains(BigDecimal x)

Description copied from interface: Range

Determines whether the supplied point lies within this range. For continuous ranges this is interpreted as a pair of inequalities on the supplied value (i.e., min <= x <= max), but for discrete ranges the contains() method is more like a set membership test.

Returns:

a boolean to indicate whether the supplied point lies within the range

stretch

public BigDecimalRange stretch(double stretchFactor)

Creates a new BigDecimalRange by enlarging this numeric range about its mid-point. For example to make it 10% bigger, use a stretch factor of 1.1. Note that this method can also be used to shrink a BigDecimalRange.

Parameters:

stretchFactor - the multiplication factor for the enlargement

Returns:

a new BigDecimalRange

stretch

public BigDecimalRange stretch(double stretchFactorForLower,
                               double stretchFactorForUpper)

Creates a new BigDecimalRange by enlarging this numeric range about its mid-point. For example to make it 10% bigger, use a stretch factor of 1.1. Note that this method can also be used to shrink a BigDecimalRange.

Parameters:

stretchFactorForLower - the multiplication factor for the enlargement for the lower range

stretchFactorForUpper - the multiplication factor for the enlargement for the upper range

Returns:

a new BigDecimalRange

createIntermediate

public Range<BigDecimal> createIntermediate(Range<BigDecimal> target,
                                            double position)

Specified by:

createIntermediate in class AbstractRange<BigDecimal>

equals

public boolean equals(Object other)

Test for equality based on the values of min and max

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object