org.apache.commons.math
Class MathException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.apache.commons.math.MathException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CardanEulerSingularityException, ConvergenceException, DerivativeException, DimensionMismatchException, DuplicateSampleAbscissaException, EstimationException, EventException, FunctionEvaluationException, IntegratorException, MathConfigurationException, NotARotationMatrixException, NotPositiveDefiniteMatrixException, NotSymmetricMatrixException

public class MathException
extends Exception

Base class for commons-math checked exceptions.

Supports nesting, emulating JDK 1.4 behavior if necessary.

Adapted from .

Version:
$Revision: 780674 $ $Date: 2009-06-01 11:10:55 -0400 (Mon, 01 Jun 2009) $
See Also:
Serialized Form

Field Summary
private  Object[] arguments
          Arguments used to build the message.
private  String pattern
          Pattern used to build the message.
private static long serialVersionUID
          Serializable version identifier.
 
Constructor Summary
MathException()
          Constructs a new MathException with no detail message.
MathException(String pattern, Object... arguments)
          Constructs a new MathException with specified formatted detail message.
MathException(Throwable rootCause)
          Constructs a new MathException with specified nested Throwable root cause.
MathException(Throwable rootCause, String pattern, Object... arguments)
          Constructs a new MathException with specified formatted detail message and nested Throwable root cause.
 
Method Summary
private static String buildMessage(Locale locale, String pattern, Object... arguments)
          Builds a message string by from a pattern and its arguments.
 Object[] getArguments()
          Gets the arguments used to build the message of this throwable.
 String getLocalizedMessage()
          
 String getMessage(Locale locale)
          Gets the message in a specified locale.
 String getPattern()
          Gets the pattern used to build the message of this throwable.
 void printStackTrace()
          Prints the stack trace of this exception to the standard error stream.
 void printStackTrace(PrintStream out)
          Prints the stack trace of this exception to the specified stream.
private static String translate(String s, Locale locale)
          Translate a string to a given locale.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serializable version identifier.

See Also:
Constant Field Values

pattern

private final String pattern
Pattern used to build the message.


arguments

private final Object[] arguments
Arguments used to build the message.

Constructor Detail

MathException

public MathException()
Constructs a new MathException with no detail message.


MathException

public MathException(String pattern,
                     Object... arguments)
Constructs a new MathException with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:
pattern - format specifier
arguments - format arguments

MathException

public MathException(Throwable rootCause)
Constructs a new MathException with specified nested Throwable root cause.

Parameters:
rootCause - the exception or error that caused this exception to be thrown.

MathException

public MathException(Throwable rootCause,
                     String pattern,
                     Object... arguments)
Constructs a new MathException with specified formatted detail message and nested Throwable root cause. Message formatting is delegated to MessageFormat.

Parameters:
rootCause - the exception or error that caused this exception to be thrown.
pattern - format specifier
arguments - format arguments
Since:
1.2
Method Detail

translate

private static String translate(String s,
                                Locale locale)
Translate a string to a given locale.

Parameters:
s - string to translate
locale - locale into which to translate the string
Returns:
translated string or original string for unsupported locales or unknown strings

buildMessage

private static String buildMessage(Locale locale,
                                   String pattern,
                                   Object... arguments)
Builds a message string by from a pattern and its arguments.

Parameters:
locale - Locale in which the message should be translated
pattern - format specifier
arguments - format arguments
Returns:
a message string

getPattern

public String getPattern()
Gets the pattern used to build the message of this throwable.

Returns:
the pattern used to build the message of this throwable
Since:
1.2

getArguments

public Object[] getArguments()
Gets the arguments used to build the message of this throwable.

Returns:
the arguments used to build the message of this throwable
Since:
1.2

getMessage

public String getMessage(Locale locale)
Gets the message in a specified locale.

Parameters:
locale - Locale in which the message should be translated
Returns:
localized message
Since:
1.2

getLocalizedMessage

public String getLocalizedMessage()

Overrides:
getLocalizedMessage in class Throwable

printStackTrace

public void printStackTrace()
Prints the stack trace of this exception to the standard error stream.

Overrides:
printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified stream.

Overrides:
printStackTrace in class Throwable
Parameters:
out - the PrintStream to use for output


Copyright (c) 2003-2010 Apache Software Foundation