com.deltaxml.core

Class UnknownParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.deltaxml.api.DeltaXMLException

com.deltaxml.core.DXPConfigurationException

com.deltaxml.core.UnknownParameterException

All Implemented Interfaces:

java.io.Serializable

public class UnknownParameterException
extends DXPConfigurationException

Thrown when an attempt was made to reference an unknown or undeclared DXP parameter.

It is possible to use a parameter name which has not been declared in the DXP pipelineParameters section. This exception reports that name and the context in which it was being incorrectly used.

See Also:

DXPConfiguration#generate(), DXPConfiguration#generate(java.util.Map, java.util.Map), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnknownParameterException(java.lang.String message, java.lang.String parameterName, java.lang.String parameterContext) Creates a new UnknownParameterException.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUnkownParameterContext() Provides the context in which the parameter was attempting to be used.
java.lang.String	getUnkownParameterName() Provides the name of the unknown or undeclared parameter.

Methods inherited from class com.deltaxml.api.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 Detail

UnknownParameterException

public UnknownParameterException(java.lang.String message,
                                 java.lang.String parameterName,
                                 java.lang.String parameterContext)

Creates a new UnknownParameterException.

Parameters:

message - The exception message string

parameterName - The name of the unknown parameter

parameterContext - The context (name of the DXP element, eg: parameter, feature) in which the missing parameter was being used.

Method Detail

getUnkownParameterName

public java.lang.String getUnkownParameterName()

Provides the name of the unknown or undeclared parameter.

Returns:

the name of the unknown parameter

getUnkownParameterContext

public java.lang.String getUnkownParameterContext()

Provides the context in which the parameter was attempting to be used.

Returns:

an element name for the context