Package org.apache.commons.math.exception

Class NonMonotonousSequenceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.apache.commons.math.exception.MathIllegalArgumentException

org.apache.commons.math.exception.MathIllegalNumberException

org.apache.commons.math.exception.NonMonotonousSequenceException

All Implemented Interfaces:

java.io.Serializable, MathThrowable

public class NonMonotonousSequenceException
extends MathIllegalNumberException

Exception to be thrown when the a sequence of values is not monotonously increasing or decreasing.

Since:

2.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NonMonotonousSequenceException(java.lang.Number wrong, java.lang.Number previous, int index)	Construct the exception.
NonMonotonousSequenceException(java.lang.Number wrong, java.lang.Number previous, int index, MathUtils.OrderDirection direction, boolean strict)	Construct the exception.

Method Summary

Modifier and Type	Method	Description
MathUtils.OrderDirection	getDirection()
int	getIndex()	Get the index of the wrong value.
java.lang.Number	getPrevious()
boolean	getStrict()

Methods inherited from class org.apache.commons.math.exception.MathIllegalNumberException

getArgument

Methods inherited from class org.apache.commons.math.exception.MathIllegalArgumentException

getArguments, getGeneralPattern, getLocalizedMessage, getMessage, getMessage, getSpecificPattern

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NonMonotonousSequenceException

public NonMonotonousSequenceException(java.lang.Number wrong,
                                      java.lang.Number previous,
                                      int index)

Construct the exception. This constructor uses default values assuming that the sequence should have been strictly increasing.

Parameters:

wrong - Value that did not match the requirements.

previous - Previous value in the sequence.

index - Index of the value that did not match the requirements.

NonMonotonousSequenceException

public NonMonotonousSequenceException(java.lang.Number wrong,
                                      java.lang.Number previous,
                                      int index,
                                      MathUtils.OrderDirection direction,
                                      boolean strict)

Construct the exception.

Parameters:

wrong - Value that did not match the requirements.

previous - Previous value in the sequence.

index - Index of the value that did not match the requirements.

direction - Strictly positive for a sequence required to be increasing, negative (or zero) for a decreasing sequence.

strict - Whether the sequence must be strictly increasing or decreasing.

Method Detail

getDirection

public MathUtils.OrderDirection getDirection()

Returns:

the order direction.

getStrict

public boolean getStrict()

Returns:

true is the sequence should be strictly monotonous.

getIndex

public int getIndex()

Get the index of the wrong value.

Returns:

the current index.

getPrevious

public java.lang.Number getPrevious()

Returns:

the previous value.