cse1030

Class Range

java.lang.Object

cse1030.Range

public class Range
extends java.lang.Object

A class that represents an integer value that is always between some minimum and maximum value. A range has three properties: minimum, maximum, and value. Range objects always ensure that the following class invariant is true:

minimum <= value <= maximum

The mutator methods of the class are responsible for ensuring that the above class invariant is always true. For example, if the minimum value of the range is changed so that it is greater than the current value, then the current value is also adjusted to maintain the class invariant. If the minimum value is changed so that it is greater than the maximum value, then both the maximum value and current value are also changed to maintain the class invariant.

Author:

CSE1030Z

Constructor Summary

Constructors

Constructor and Description
Range() Create a range with minimum value 0, maximum value 100, and initial value 50.
Range(int min, int max) Create a range with the specified minimum and maximum values.
Range(int min, int max, int init) Create a range with the specified minimum, maximum, and initial values.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaximum() Returns the maximum value of the range
int	getMinimum() Returns the minimum value of the range
int	getValue() Return the current value of the range.
void	setMaximum(int newMaximum) Sets the maximum value of the range to newMaximum.
void	setMinimum(int newMinimum) Sets the minimum value of the range to newMinimum.
void	setValue(int newValue) Set the current value of the range to newValue if newValue satisfies the constraints of the range.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Range

public Range()

Create a range with minimum value 0, maximum value 100, and initial value 50.

Range

public Range(int min,
     int max)

Create a range with the specified minimum and maximum values. The initial value is set to half way between the minimum and maximum values (rounded down to the nearest integer if max - min is odd).

Parameters:

min - the minimum value of the range

max - the maximum value of the range

Throws:

java.lang.IllegalArgumentException - if min > max

Range

public Range(int min,
     int max,
     int init)

Create a range with the specified minimum, maximum, and initial values.

Parameters:

min - the minimum value of the range

max - the maximum value of the range

init - the initial value of the range

Throws:

java.lang.IllegalArgumentException - if the constraint min <= init <= max is not satisfied

Method Detail

getMinimum

public int getMinimum()

Returns the minimum value of the range

Returns:

the minimum value of the range

setMinimum

public void setMinimum(int newMinimum)

Sets the minimum value of the range to newMinimum. The other properties of the range may be changed to ensure that:

minimum <= value <= maximum

Parameters:

newMinimum - the new minimum of the range

getMaximum

public int getMaximum()

Returns the maximum value of the range

Returns:

the maximum value of the range

setMaximum

public void setMaximum(int newMaximum)

Sets the maximum value of the range to newMaximum. The other properties of the range may be changed to ensure that:

minimum <= value <= maximum

Parameters:

newMaximum - the new maximum of the range

getValue

public int getValue()

Return the current value of the range.

Returns:

the value of the range

setValue

public void setValue(int newValue)

Set the current value of the range to newValue if newValue satisfies the constraints of the range. Those constraints are:

minimum <= value <= maximum

Otherwise, if newValue < minimum then the value is set to the minimum value of the range, and if newValue > maximum then the value is set to the maximum value of the range.

Parameters:

value - the new value of the range