Package org.apache.camel.dataformat.bindy.annotation

Annotation Interface Message

@Documented @Retention(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

    Required Elements
    Modifier and Type
    Required Element
    Description
    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

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    crlf
    Character to be used to add a carriage return after each record (optional).
    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 Details

    • pairSeparator

      String pairSeparator
      Pair separator used to split the key value pairs in tokens (mandatory). Can be '=', ';', or 'anything'.
      Returns:
      String

    • keyValuePairSeparator

      String keyValuePairSeparator
      Key value pair separator is used to split the values from their keys (mandatory). Can be '', ' ', '#', or 'anything'.
      Returns:
      String

    • name

      String name
      Name describing the message (optional)
      Returns:
      String
      Default:
      ""

    • type

      String type
      type is used to define the type of the message (e.g. FIX, EMX, ...) (optional)
      Default:
      "FIX"

    • version

      String version
      version defines the version of the message (e.g. 4.1, ...) (optional)
      Default:
      "4.1"

    • crlf

      String crlf
      Character to be used to add a carriage return after each record (optional). Possible values = WINDOWS, UNIX, MAC, or custom. If you specify a value other than the three listed before, the value you enter (custom) will be used as the CRLF character(s).
      Returns:
      String
      Default:
      "WINDOWS"

    • isOrdered

      boolean isOrdered
      Indicates if the message must be ordered in output. This annotation is associated to the message class of the model and must be declared one time.
      Returns:
      boolean
      Default:
      false