Package etithespirit.orimod.api.util.valuetypes

Class MutableNumberRange

java.lang.Object

etithespirit.orimod.api.util.valuetypes.NumberRange

etithespirit.orimod.api.util.valuetypes.MutableNumberRange

public class MutableNumberRange
extends NumberRange

An implementation of NumberRange that can have its minimum and maximum set after construction.

Author:

Eti

Field Summary

Fields inherited from class etithespirit.orimod.api.util.valuetypes.NumberRange

max, min, rng, ZERO

Constructor Summary

Constructors

Constructor	Description
MutableNumberRange(double min, double max)	Creates a new range between min and max.
MutableNumberRange(double min, double max, Random rng)	Creates a new range between min and max, using the given randomizer for the NumberRange.random() method.

Method Summary

Modifier and Type	Method	Description
NumberRange	immutableCopy()
boolean	isMutable()
MutableNumberRange	mutableCopy()
void	setMax(double max)	Sets the value of max.
void	setMin(double min)	Sets the value of min.
void	setMinAndMax(double min, double max)	A method to set both the value of min and the value of max simultaneously.

Methods inherited from class etithespirit.orimod.api.util.valuetypes.NumberRange

equals, getMax, getMin, isSingular, lerp, random

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MutableNumberRange

public MutableNumberRange(double min,
 double max)
                   throws IllegalArgumentException

Creates a new range between min and max. If min is greater than max, an IllegalArgumentException is thrown.

Parameters:

min - The minimum possible value to contain.

max - The maximum possible value to contain.

Throws:

IllegalArgumentException - If min is greater than max.

MutableNumberRange

public MutableNumberRange(double min,
 double max,
 Random rng)
                   throws IllegalArgumentException

Creates a new range between min and max, using the given randomizer for the NumberRange.random() method. If min is greater than max, an IllegalArgumentException is thrown.

Parameters:

min - The minimum possible value to contain.

max - The maximum possible value to contain.

rng - The randomizer to use in the NumberRange.random() method.

Throws:

IllegalArgumentException - If min is greater than max.

Method Details

setMin

public void setMin(double min)
            throws IllegalArgumentException

Sets the value of min.

Parameters:

min - The new value of min.

Throws:

IllegalArgumentException - If the new value is greater than the current maximum.

setMax

public void setMax(double max)
            throws IllegalArgumentException

Sets the value of max.

Parameters:

max - The new value of max.

Throws:

IllegalArgumentException - If the new value is less than the current minimum.

setMinAndMax

public void setMinAndMax(double min,
 double max)
                  throws IllegalArgumentException

A method to set both the value of min and the value of max simultaneously.

Parameters:

min - The new value of min.

max - The new value of max.

Throws:

IllegalArgumentException - If min is greater than max.

isMutable

public boolean isMutable()

Overrides:

isMutable in class NumberRange

Returns:

Whether or not this NumberRange is able to have its minimum and maximum edited.

immutableCopy

public NumberRange immutableCopy()

Overrides:

immutableCopy in class NumberRange

Returns:

A copy of this NumberRange as an immutable instance.

mutableCopy

public MutableNumberRange mutableCopy()

Overrides:

mutableCopy in class NumberRange

Returns:

A copy of this NumberRange as a mutable instance.