Package de.otto.synapse.translator

Enum Class MessageFormat

java.lang.Object

java.lang.Enum<MessageFormat>

de.otto.synapse.translator.MessageFormat

All Implemented Interfaces:

Serializable, Comparable<MessageFormat>, Constable

public enum MessageFormat
extends Enum<MessageFormat>

Identifies the format used to encode or decode messages.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
V1	String representation of the message only contains the message payload; no header attributes supported.
V2	String representation of the message contains version, header attributes and payload in JSON format

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SYNAPSE_MSG_COMPACTIONKEY
static final String	SYNAPSE_MSG_FORMAT
static final String	SYNAPSE_MSG_HEADERS
static final String	SYNAPSE_MSG_KEY
static final String	SYNAPSE_MSG_PARTITIONKEY
static final String	SYNAPSE_MSG_PAYLOAD

Method Summary

Modifier and Type	Method	Description
static MessageFormat	defaultMessageFormat()	Returns the default message format used by Synapse to encode messages.
static MessageFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
static MessageFormat	versionOf(String message)	Determines the MessageFormat from the string representation of some message.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

V1

public static final MessageFormat V1

String representation of the message only contains the message payload; no header attributes supported.

V2

public static final MessageFormat V2

String representation of the message contains version, header attributes and payload in JSON format

Field Details

SYNAPSE_MSG_FORMAT

public static final String SYNAPSE_MSG_FORMAT

See Also:

• Constant Field Values

SYNAPSE_MSG_KEY

public static final String SYNAPSE_MSG_KEY

See Also:

• Constant Field Values

SYNAPSE_MSG_COMPACTIONKEY

public static final String SYNAPSE_MSG_COMPACTIONKEY

See Also:

• Constant Field Values

SYNAPSE_MSG_PARTITIONKEY

public static final String SYNAPSE_MSG_PARTITIONKEY

See Also:

• Constant Field Values

SYNAPSE_MSG_HEADERS

public static final String SYNAPSE_MSG_HEADERS

See Also:

• Constant Field Values

SYNAPSE_MSG_PAYLOAD

public static final String SYNAPSE_MSG_PAYLOAD

See Also:

• Constant Field Values

Method Details

values

public static MessageFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MessageFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

defaultMessageFormat

public static MessageFormat defaultMessageFormat()

Returns the default message format used by Synapse to encode messages.

Returns:

the default message format

versionOf

public static MessageFormat versionOf(String message)

Determines the MessageFormat from the string representation of some message.

Parameters:

message - the string representation of some message

Returns:

MessageFormat of the message