org.springframework.xd.dirt.stream.dsl

Enum XDDSLMessages

java.lang.Object

java.lang.Enum<XDDSLMessages>

org.springframework.xd.dirt.stream.dsl.XDDSLMessages

All Implemented Interfaces:

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

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

Contains all the messages that can be produced during Spring XD 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	XDDSLMessages.Kind

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMBIGUOUS_MODULE_NAME
CANNOT_USE_COMPOSEDMODULE_HERE_ALREADY_HAS_SINK_CHANNEL
CANNOT_USE_COMPOSEDMODULE_HERE_ALREADY_HAS_SOURCE_CHANNEL
CANNOT_USE_COMPOSEDMODULE_HERE_AS_IT_DEFINES_SINK_CHANNEL
CANNOT_USE_COMPOSEDMODULE_HERE_AS_IT_DEFINES_SOURCE_CHANNEL
CHANNEL_INDEXING_NOT_ALLOWED
DUPLICATE_LABEL
EXPECTED_ARGUMENT_VALUE
EXPECTED_CHANNEL_NAME
EXPECTED_CHANNEL_PREFIX_QUEUE_TOPIC
EXPECTED_CHANNEL_PREFIX_QUEUE_TOPIC_TAP
EXPECTED_CHANNEL_QUALIFIER
EXPECTED_MODULENAME
EXPECTED_WHITESPACE_AFTER_MODULE_BEFORE_ARGUMENT
ILLEGAL_STREAM_NAME
MISSING_CHARACTER
MISSING_VALUE_FOR_VARIABLE
MODULE_REFERENCE_NOT_UNIQUE
MORE_INPUT
NAMED_CHANNELS_UNSUPPORTED_HERE
NO_WHITESPACE_BEFORE_ARG_EQUALS
NO_WHITESPACE_BEFORE_ARG_NAME
NO_WHITESPACE_BEFORE_ARG_VALUE
NO_WHITESPACE_BETWEEN_LABEL_NAME_AND_COLON
NO_WHITESPACE_IN_CHANNEL_DEFINITION
NO_WHITESPACE_IN_DOTTED_NAME
NON_TERMINATING_DOUBLE_QUOTED_STRING
NON_TERMINATING_QUOTED_STRING
NOT_ALLOWED_TO_TAP_THAT
NOT_EXPECTED_TOKEN
ONLY_A_TAP_ON_A_STREAM_OR_JOB_CAN_BE_INDEXED
OOD
STREAM_NAME_MATCHING_MODULE_NAME
TAP_NEEDS_THREE_COMPONENTS
UNEXPECTED_DATA
UNEXPECTED_DATA_AFTER_STREAMDEF
UNEXPECTED_ESCAPE_CHAR
UNRECOGNIZED_MODULE_REFERENCE
UNRECOGNIZED_STREAM_REFERENCE
VARIABLE_NOT_TERMINATED

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.
XDDSLMessages.Kind	getKind()
static XDDSLMessages	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static XDDSLMessages[]	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_STREAMDEF

public static final XDDSLMessages UNEXPECTED_DATA_AFTER_STREAMDEF

NO_WHITESPACE_BEFORE_ARG_NAME

public static final XDDSLMessages NO_WHITESPACE_BEFORE_ARG_NAME

NO_WHITESPACE_BEFORE_ARG_EQUALS

public static final XDDSLMessages NO_WHITESPACE_BEFORE_ARG_EQUALS

NO_WHITESPACE_BEFORE_ARG_VALUE

public static final XDDSLMessages NO_WHITESPACE_BEFORE_ARG_VALUE

MORE_INPUT

public static final XDDSLMessages MORE_INPUT

EXPECTED_ARGUMENT_VALUE

public static final XDDSLMessages EXPECTED_ARGUMENT_VALUE

NON_TERMINATING_DOUBLE_QUOTED_STRING

public static final XDDSLMessages NON_TERMINATING_DOUBLE_QUOTED_STRING

NON_TERMINATING_QUOTED_STRING

public static final XDDSLMessages NON_TERMINATING_QUOTED_STRING

MISSING_CHARACTER

public static final XDDSLMessages MISSING_CHARACTER

NOT_EXPECTED_TOKEN

public static final XDDSLMessages NOT_EXPECTED_TOKEN

OOD

public static final XDDSLMessages OOD

UNEXPECTED_ESCAPE_CHAR

public static final XDDSLMessages UNEXPECTED_ESCAPE_CHAR

UNEXPECTED_DATA

public static final XDDSLMessages UNEXPECTED_DATA

UNRECOGNIZED_STREAM_REFERENCE

public static final XDDSLMessages UNRECOGNIZED_STREAM_REFERENCE

UNRECOGNIZED_MODULE_REFERENCE

public static final XDDSLMessages UNRECOGNIZED_MODULE_REFERENCE

EXPECTED_MODULENAME

public static final XDDSLMessages EXPECTED_MODULENAME

EXPECTED_WHITESPACE_AFTER_MODULE_BEFORE_ARGUMENT

public static final XDDSLMessages EXPECTED_WHITESPACE_AFTER_MODULE_BEFORE_ARGUMENT

EXPECTED_CHANNEL_QUALIFIER

public static final XDDSLMessages EXPECTED_CHANNEL_QUALIFIER

EXPECTED_CHANNEL_NAME

public static final XDDSLMessages EXPECTED_CHANNEL_NAME

ILLEGAL_STREAM_NAME

public static final XDDSLMessages ILLEGAL_STREAM_NAME

MISSING_VALUE_FOR_VARIABLE

public static final XDDSLMessages MISSING_VALUE_FOR_VARIABLE

VARIABLE_NOT_TERMINATED

public static final XDDSLMessages VARIABLE_NOT_TERMINATED

AMBIGUOUS_MODULE_NAME

public static final XDDSLMessages AMBIGUOUS_MODULE_NAME

STREAM_NAME_MATCHING_MODULE_NAME

public static final XDDSLMessages STREAM_NAME_MATCHING_MODULE_NAME

CHANNEL_INDEXING_NOT_ALLOWED

public static final XDDSLMessages CHANNEL_INDEXING_NOT_ALLOWED

ONLY_A_TAP_ON_A_STREAM_OR_JOB_CAN_BE_INDEXED

public static final XDDSLMessages ONLY_A_TAP_ON_A_STREAM_OR_JOB_CAN_BE_INDEXED

EXPECTED_CHANNEL_PREFIX_QUEUE_TOPIC

public static final XDDSLMessages EXPECTED_CHANNEL_PREFIX_QUEUE_TOPIC

EXPECTED_CHANNEL_PREFIX_QUEUE_TOPIC_TAP

public static final XDDSLMessages EXPECTED_CHANNEL_PREFIX_QUEUE_TOPIC_TAP

CANNOT_USE_COMPOSEDMODULE_HERE_AS_IT_DEFINES_SOURCE_CHANNEL

public static final XDDSLMessages CANNOT_USE_COMPOSEDMODULE_HERE_AS_IT_DEFINES_SOURCE_CHANNEL

CANNOT_USE_COMPOSEDMODULE_HERE_AS_IT_DEFINES_SINK_CHANNEL

public static final XDDSLMessages CANNOT_USE_COMPOSEDMODULE_HERE_AS_IT_DEFINES_SINK_CHANNEL

CANNOT_USE_COMPOSEDMODULE_HERE_ALREADY_HAS_SOURCE_CHANNEL

public static final XDDSLMessages CANNOT_USE_COMPOSEDMODULE_HERE_ALREADY_HAS_SOURCE_CHANNEL

CANNOT_USE_COMPOSEDMODULE_HERE_ALREADY_HAS_SINK_CHANNEL

public static final XDDSLMessages CANNOT_USE_COMPOSEDMODULE_HERE_ALREADY_HAS_SINK_CHANNEL

NO_WHITESPACE_IN_CHANNEL_DEFINITION

public static final XDDSLMessages NO_WHITESPACE_IN_CHANNEL_DEFINITION

NO_WHITESPACE_BETWEEN_LABEL_NAME_AND_COLON

public static final XDDSLMessages NO_WHITESPACE_BETWEEN_LABEL_NAME_AND_COLON

TAP_NEEDS_THREE_COMPONENTS

public static final XDDSLMessages TAP_NEEDS_THREE_COMPONENTS

NOT_ALLOWED_TO_TAP_THAT

public static final XDDSLMessages NOT_ALLOWED_TO_TAP_THAT

DUPLICATE_LABEL

public static final XDDSLMessages DUPLICATE_LABEL

MODULE_REFERENCE_NOT_UNIQUE

public static final XDDSLMessages MODULE_REFERENCE_NOT_UNIQUE

NO_WHITESPACE_IN_DOTTED_NAME

public static final XDDSLMessages NO_WHITESPACE_IN_DOTTED_NAME

NAMED_CHANNELS_UNSUPPORTED_HERE

public static final XDDSLMessages NAMED_CHANNELS_UNSUPPORTED_HERE

Method Detail

values

public static XDDSLMessages[] 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 (XDDSLMessages c : XDDSLMessages.values())
    System.out.println(c);

Returns:

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

valueOf

public static XDDSLMessages 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 XDDSLMessages.Kind getKind()