org.apache.commons.math
Class FunctionEvaluationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.apache.commons.math.MathException
              extended by org.apache.commons.math.FunctionEvaluationException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ArgumentOutsideDomainException

public class FunctionEvaluationException
extends MathException

Exception thrown when an error occurs evaluating a function.

Maintains an argument property holding the input value that caused the function evaluation to fail.

Version:
$Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
See Also:
Serialized Form

Field Summary
private  double argument
          Argument causing function evaluation failure
private static long serialVersionUID
          Serializable version identifier.
 
Constructor Summary
FunctionEvaluationException(double argument)
          Construct an exception indicating the argument value that caused the function evaluation to fail.
FunctionEvaluationException(double argument, java.lang.String message)
          Deprecated. as of 1.2, replaced by FunctionEvaluationException(double, String, Object[])
FunctionEvaluationException(double argument, java.lang.String pattern, java.lang.Object[] arguments)
          Constructs an exception with specified formatted detail message.
FunctionEvaluationException(double argument, java.lang.String pattern, java.lang.Object[] arguments, java.lang.Throwable cause)
          Constructs an exception with specified formatted detail message and root cause.
FunctionEvaluationException(double argument, java.lang.String message, java.lang.Throwable cause)
          Deprecated. as of 1.2, replaced by FunctionEvaluationException(double, String, Object[], Throwable)
FunctionEvaluationException(double argument, java.lang.Throwable cause)
          Constructs an exception with specified root cause.
 
Method Summary
 double getArgument()
          Returns the function argument that caused this exception.
 
Methods inherited from class org.apache.commons.math.MathException
getArguments, getCause, getMessage, getPattern, printStackTrace, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, initCause, 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

argument

private double argument
Argument causing function evaluation failure

Constructor Detail

FunctionEvaluationException

public FunctionEvaluationException(double argument)
Construct an exception indicating the argument value that caused the function evaluation to fail.

Parameters:
argument - the failing function argument

FunctionEvaluationException

public FunctionEvaluationException(double argument,
                                   java.lang.String message)
Deprecated. as of 1.2, replaced by FunctionEvaluationException(double, String, Object[])

Construct an exception using the given argument and message text.

Parameters:
argument - the failing function argument
message - the exception message text

FunctionEvaluationException

public FunctionEvaluationException(double argument,
                                   java.lang.String pattern,
                                   java.lang.Object[] arguments)
Constructs an exception with specified formatted detail message. Message formatting is delegated to MessageFormat.

Parameters:
argument - the failing function argument
pattern - format specifier
arguments - format arguments
Since:
1.2

FunctionEvaluationException

public FunctionEvaluationException(double argument,
                                   java.lang.String message,
                                   java.lang.Throwable cause)
Deprecated. as of 1.2, replaced by FunctionEvaluationException(double, String, Object[], Throwable)

Construct an exception with the given argument, message and root cause.

Parameters:
argument - the failing function argument
message - descriptive error message
cause - root cause.

FunctionEvaluationException

public FunctionEvaluationException(double argument,
                                   java.lang.Throwable cause)
Constructs an exception with specified root cause. Message formatting is delegated to MessageFormat.

Parameters:
argument - the failing function argument
cause - the exception or error that caused this exception to be thrown
Since:
1.2

FunctionEvaluationException

public FunctionEvaluationException(double argument,
                                   java.lang.String pattern,
                                   java.lang.Object[] arguments,
                                   java.lang.Throwable cause)
Constructs an exception with specified formatted detail message and root cause. Message formatting is delegated to MessageFormat.

Parameters:
argument - the failing function argument
pattern - format specifier
arguments - format arguments
cause - the exception or error that caused this exception to be thrown
Since:
1.2
Method Detail

getArgument

public double getArgument()
Returns the function argument that caused this exception.

Returns:
argument that caused function evaluation to fail