Package org.apache.commons.math.exception

Class MathIllegalStateException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalStateException

org.apache.commons.math.exception.MathIllegalStateException

All Implemented Interfaces:

java.io.Serializable, MathThrowable

Direct Known Subclasses:

ConvergenceException, MathInternalError, NoDataException

public class MathIllegalStateException
extends java.lang.IllegalStateException
implements MathThrowable

Base class for all exceptions that signal a mismatch between the current state and the user's expectations.

Since:

2.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MathIllegalStateException(java.lang.Throwable cause, Localizable general, java.lang.Object... args)	Simple constructor.
MathIllegalStateException(java.lang.Throwable cause, Localizable specific, Localizable general, java.lang.Object... args)	Simple constructor.
MathIllegalStateException(Localizable general, java.lang.Object... args)
MathIllegalStateException(Localizable specific, Localizable general, java.lang.Object... args)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.Object[]	getArguments()	Gets the arguments used to build the message of this throwable.
Localizable	getGeneralPattern()	Gets the localizable pattern used to build the general part of the message of this throwable.
java.lang.String	getLocalizedMessage()	Gets the message in the system default locale.
java.lang.String	getMessage()	Gets the message in a conventional US locale.
java.lang.String	getMessage(java.util.Locale locale)	Get the message in a specified locale.
Localizable	getSpecificPattern()	Gets the localizable pattern used to build the specific part of the message of this throwable.

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

MathIllegalStateException

public MathIllegalStateException(Localizable specific,
                                 Localizable general,
                                 java.lang.Object... args)

Simple constructor.

Parameters:

specific - Message pattern providing the specific context of the error.

general - Message pattern explaining the cause of the error.

args - Arguments.

MathIllegalStateException

public MathIllegalStateException(java.lang.Throwable cause,
                                 Localizable specific,
                                 Localizable general,
                                 java.lang.Object... args)

Simple constructor.

Parameters:

cause - root cause

specific - Message pattern providing the specific context of the error.

general - Message pattern explaining the cause of the error.

args - Arguments.

MathIllegalStateException

public MathIllegalStateException(Localizable general,
                                 java.lang.Object... args)

Parameters:

general - Message pattern explaining the cause of the error.

args - Arguments.

MathIllegalStateException

public MathIllegalStateException(java.lang.Throwable cause,
                                 Localizable general,
                                 java.lang.Object... args)

Simple constructor.

Parameters:

cause - root cause

general - Message pattern explaining the cause of the error.

args - Arguments.

Method Detail

getSpecificPattern

public Localizable getSpecificPattern()

Gets the localizable pattern used to build the specific part of the message of this throwable.

Specified by:

getSpecificPattern in interface MathThrowable

Returns:

localizable pattern used to build the specific part of the message of this throwable

getGeneralPattern

public Localizable getGeneralPattern()

Gets the localizable pattern used to build the general part of the message of this throwable.

Specified by:

getGeneralPattern in interface MathThrowable

Returns:

localizable pattern used to build the general part of the message of this throwable

getArguments

public java.lang.Object[] getArguments()

Gets the arguments used to build the message of this throwable.

Specified by:

getArguments in interface MathThrowable

Returns:

the arguments used to build the message of this throwable

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Get the message in a specified locale.

Specified by:

getMessage in interface MathThrowable

Parameters:

locale - Locale in which the message should be translated.

Returns:

the localized message.

getMessage

public java.lang.String getMessage()

Gets the message in a conventional US locale.

Specified by:

getMessage in interface MathThrowable

Overrides:

getMessage in class java.lang.Throwable

Returns:

localized message

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Gets the message in the system default locale.

Specified by:

getLocalizedMessage in interface MathThrowable

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

localized message