Package com.deltaxml.docbook

Class InvalidParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.core.exceptions.DeltaXMLException

com.deltaxml.docbook.InvalidParameterException

All Implemented Interfaces:

Serializable

public class InvalidParameterException
extends DeltaXMLException

Thrown to indicate that a parameter or its value is invalid. For example, the parameter dose not exist or its value is not in the expected range.

Since:

4.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidParameterException(String message, String parameterName, Object parameterValue)	Creates a new InvalidParameterException.
InvalidParameterException(String message, Throwable t, String parameterName, Object parameterValue)	Creates a new InvalidParameterException.

Method Summary

Modifier and Type	Method	Description
String	getParameterName()	Provides the name of the parameter that was causing the problem.
Object	getParameterValue()	Provides the name of the parameter that was causing the problem.

Methods inherited from class com.deltaxml.core.exceptions.DeltaXMLException

getCause, getThrowable

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

InvalidParameterException

public InvalidParameterException(String message,
 String parameterName,
 Object parameterValue)

Creates a new InvalidParameterException.

Parameters:

message - The exception message String

parameterName - the parameter which is at fault

parameterValue - the value of the parameter

InvalidParameterException

public InvalidParameterException(String message,
 Throwable t,
 String parameterName,
 Object parameterValue)

Creates a new InvalidParameterException.

Parameters:

message - the Exception message String

t - a nested Throwable that caused this Exception

parameterName - the name of the parameter which is at fault

parameterValue - the value of the parameter

Method Details

getParameterName

public String getParameterName()

Provides the name of the parameter that was causing the problem.

Returns:

the name of the parameter that was to be set

getParameterValue

public Object getParameterValue()

Provides the name of the parameter that was causing the problem.

Returns:

the name of the parameter that was to be set