org.springframework.xd.dirt.job.dsl

Class JobSpecificationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.xd.dirt.job.dsl.JobSpecificationException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CheckpointedJobDefinitionException

public class JobSpecificationException
extends java.lang.RuntimeException

Root exception for Job Flow DSL parsing related exceptions. Rather than holding a hard coded string indicating the problem, it records a message key and the inserts for the message. See JobDSLMessage for the list of all possible messages that can occur.

Author:

Andy Clement

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	expressionString
protected java.lang.Object[]	inserts
protected JobDSLMessage	message
protected int	position

Constructor Summary

Constructors

Constructor and Description
JobSpecificationException(java.lang.String expressionString, int position, JobDSLMessage message, java.lang.Object... inserts)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getExpressionString()
java.lang.Object[]	getInserts()
java.lang.String	getMessage()
JobDSLMessage	getMessageCode()
int	getPosition()
java.util.Map<java.lang.String,java.lang.Object>	toExceptionDescriptor() Produce a simple map of information about the exception that can be sent to the client for display.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

expressionString

protected java.lang.String expressionString

position

protected int position

message

protected JobDSLMessage message

inserts

protected java.lang.Object[] inserts

Constructor Detail

JobSpecificationException

public JobSpecificationException(java.lang.String expressionString,
                         int position,
                         JobDSLMessage message,
                         java.lang.Object... inserts)

Method Detail

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

Returns:

a formatted message with inserts applied

getMessageCode

public JobDSLMessage getMessageCode()

Returns:

the message code

getInserts

public java.lang.Object[] getInserts()

Returns:

the message inserts

getExpressionString

public final java.lang.String getExpressionString()

Returns:

the dsl expression text

getPosition

public final int getPosition()

Returns:

location of the error in the expression text

toExceptionDescriptor

public java.util.Map<java.lang.String,java.lang.Object> toExceptionDescriptor()

Produce a simple map of information about the exception that can be sent to the client for display.

Returns:

map of simple information including message and position