org.apache.camel.dataformat.bindy.annotation
Annotation Type Message


@Documented
@Retention(value=RUNTIME)
public @interface Message

This annotation represents the root class of the model. When a message (FIX message containing key-value pairs) must be described in the model, we will use this annotation. The key pair separator (mandatory) defines the separator between the key and the value The pair separator (mandatory) allows to define which character separate the pairs from each other The name is optional and could be used in the future to bind a property which a different name The type (optional) allow to define the type of the message (e.g. FIX, EMX, ...) The version (optional) defines the version of the message (e.g. 4.1, ...) The crlf (optional) is used to add a new line after a record. By default, the value is WINDOWS The isOrdered (optional) boolean is used to ordered the message generated in output (line feed and carriage return on windows


Required Element Summary
 String keyValuePairSeparator
          Key value pair separator is used to split the values from their keys (mandatory)
 String pairSeparator
          Pair separator used to split the key value pairs in tokens (mandatory)
 
Optional Element Summary
 String crlf
          Character to be used to add a carriage return after each record (optional) Three values can be used : WINDOWS, UNIX or MAC
 boolean isOrdered
          Indicates if the message must be ordered in output
 String name
          Name describing the message (optional)
 String type
          type is used to define the type of the message (e.g.
 String version
          version defines the version of the message (e.g.
 

Element Detail

pairSeparator

public abstract String pairSeparator
Pair separator used to split the key value pairs in tokens (mandatory)

Returns:
String

keyValuePairSeparator

public abstract String keyValuePairSeparator
Key value pair separator is used to split the values from their keys (mandatory)

Returns:
String

name

public abstract String name
Name describing the message (optional)

Returns:
String
Default:
""

type

public abstract String type
type is used to define the type of the message (e.g. FIX, EMX, ...) (optional)

Default:
"FIX"

version

public abstract String version
version defines the version of the message (e.g. 4.1, ...) (optional)

Default:
"4.1"

crlf

public abstract String crlf
Character to be used to add a carriage return after each record (optional) Three values can be used : WINDOWS, UNIX or MAC

Returns:
String
Default:
"WINDOWS"

isOrdered

public abstract boolean isOrdered
Indicates if the message must be ordered in output

Returns:
boolean
Default:
false


Copyright © 2007-2010 IONA Open Source Community. All Rights Reserved.