org.springframework.xd.dirt.job.dsl

Enum JobDSLMessage

java.lang.Object

java.lang.Enum<JobDSLMessage>

org.springframework.xd.dirt.job.dsl.JobDSLMessage

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobDSLMessage>

public enum JobDSLMessage
extends java.lang.Enum<JobDSLMessage>

Contains all the messages that can be produced during Spring XD Job DSL parsing. Each message has a kind (info, warn, error) and a code number. Tests can be written to expect particular code numbers rather than particular text, enabling the message text to more easily be modified and the tests to run successfully in different locales.

When a message is formatted, it will have this kind of form

 XD105E: (pos 34): Expected an argument value but was ' '
 

The prefix captures the code and the error kind, whilst the position is included if it is known.

Author:

Andy Clement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobDSLMessage.Kind

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPECTED_ARGUMENT_VALUE
EXPECTED_EQUALS_AFTER_TRANSITION_NAME
EXPECTED_FLOW_OR_SPLIT_CHARS
EXPECTED_JOB_REF_OR_DEF
EXPECTED_TRANSITION_NAME
EXPECTED_WHITESPACE_AFTER_NAME_BEFORE_ARGUMENT
JOB_REF_DOES_NOT_SUPPORT_OPTIONS
MISSING_CHARACTER
MISSING_EQUALS_AFTER_TRANSITION_NAME
MISSING_JOB_NAME_IN_INLINEJOBDEF
NO_WHITESPACE_BEFORE_ARG_EQUALS
NO_WHITESPACE_BEFORE_ARG_NAME
NO_WHITESPACE_BEFORE_ARG_VALUE
NO_WHITESPACE_IN_DOTTED_NAME
NON_TERMINATING_DOUBLE_QUOTED_STRING
NON_TERMINATING_QUOTED_STRING
NOT_EXPECTED_TOKEN
ONLY_ONE_AMPERSAND_REQUIRED
OOD
UNEXPECTED_DATA
UNEXPECTED_DATA_AFTER_JOBSPEC
UNEXPECTED_ESCAPE_CHAR

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	formatMessage(int pos, java.lang.Object... inserts) Produce a complete message including the prefix, the position (if known) and with the inserts applied to the message.
JobDSLMessage.Kind	getKind()
static JobDSLMessage	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobDSLMessage[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNEXPECTED_DATA_AFTER_JOBSPEC

public static final JobDSLMessage UNEXPECTED_DATA_AFTER_JOBSPEC

NO_WHITESPACE_BEFORE_ARG_NAME

public static final JobDSLMessage NO_WHITESPACE_BEFORE_ARG_NAME

NO_WHITESPACE_BEFORE_ARG_EQUALS

public static final JobDSLMessage NO_WHITESPACE_BEFORE_ARG_EQUALS

NO_WHITESPACE_BEFORE_ARG_VALUE

public static final JobDSLMessage NO_WHITESPACE_BEFORE_ARG_VALUE

EXPECTED_ARGUMENT_VALUE

public static final JobDSLMessage EXPECTED_ARGUMENT_VALUE

MISSING_CHARACTER

public static final JobDSLMessage MISSING_CHARACTER

NOT_EXPECTED_TOKEN

public static final JobDSLMessage NOT_EXPECTED_TOKEN

OOD

public static final JobDSLMessage OOD

UNEXPECTED_DATA

public static final JobDSLMessage UNEXPECTED_DATA

EXPECTED_WHITESPACE_AFTER_NAME_BEFORE_ARGUMENT

public static final JobDSLMessage EXPECTED_WHITESPACE_AFTER_NAME_BEFORE_ARGUMENT

NO_WHITESPACE_IN_DOTTED_NAME

public static final JobDSLMessage NO_WHITESPACE_IN_DOTTED_NAME

MISSING_JOB_NAME_IN_INLINEJOBDEF

public static final JobDSLMessage MISSING_JOB_NAME_IN_INLINEJOBDEF

EXPECTED_TRANSITION_NAME

public static final JobDSLMessage EXPECTED_TRANSITION_NAME

EXPECTED_EQUALS_AFTER_TRANSITION_NAME

public static final JobDSLMessage EXPECTED_EQUALS_AFTER_TRANSITION_NAME

NON_TERMINATING_QUOTED_STRING

public static final JobDSLMessage NON_TERMINATING_QUOTED_STRING

NON_TERMINATING_DOUBLE_QUOTED_STRING

public static final JobDSLMessage NON_TERMINATING_DOUBLE_QUOTED_STRING

UNEXPECTED_ESCAPE_CHAR

public static final JobDSLMessage UNEXPECTED_ESCAPE_CHAR

MISSING_EQUALS_AFTER_TRANSITION_NAME

public static final JobDSLMessage MISSING_EQUALS_AFTER_TRANSITION_NAME

ONLY_ONE_AMPERSAND_REQUIRED

public static final JobDSLMessage ONLY_ONE_AMPERSAND_REQUIRED

EXPECTED_JOB_REF_OR_DEF

public static final JobDSLMessage EXPECTED_JOB_REF_OR_DEF

JOB_REF_DOES_NOT_SUPPORT_OPTIONS

public static final JobDSLMessage JOB_REF_DOES_NOT_SUPPORT_OPTIONS

EXPECTED_FLOW_OR_SPLIT_CHARS

public static final JobDSLMessage EXPECTED_FLOW_OR_SPLIT_CHARS

Method Detail

values

public static JobDSLMessage[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JobDSLMessage c : JobDSLMessage.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JobDSLMessage valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

formatMessage

public java.lang.String formatMessage(int pos,
                             java.lang.Object... inserts)

Produce a complete message including the prefix, the position (if known) and with the inserts applied to the message.

Parameters:

pos - the position, if less than zero it is ignored and not included in the message

inserts - the inserts to put into the formatted message

Returns:

a formatted message

getKind

public JobDSLMessage.Kind getKind()