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

Annotation Interface KeyValuePairField

@Documented @Retention(RUNTIME) public @interface KeyValuePairField
An annotation used to identify in a POJO which property is link to a key value pair field The tag (mandatory) identifies the key of the key value pair (e.g. 8 equals the begin string in FIX The name (optional) could be used in the future to bind a property which a different name The pattern (optional) allows to define the pattern of the data (useful for Date, BigDecimal ...) The precision (optional) reflects the precision to be used with BigDecimal number The required (optional) field allows to define if the field is required or not. This property is not yet used but will be useful in the future with the validation The position (optional) field is used to order the tags during the creation of the message

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    int
    tag
    tag identifying the field in the message (mandatory) - must be unique

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    impliedDecimalSeparator
    Camel 2.11: Indicates if there is a decimal point implied at a specified location
    String
    name
    name of the field (optional)
    String
    pattern
    pattern that the formater will use to transform the data (optional)
    int
    position
    Position of the field in the message generated - must be used when the position of the key/tag in the FIX message must be different
    int
    precision
    precision of the BigDecimal number to be created
    boolean
    required
    Indicates if the field is mandatory
    String
    timezone
    Timezone to be used.

  • Element Details

    • tag

      int tag
      tag identifying the field in the message (mandatory) - must be unique
      Returns:
      int

    • name

      String name
      name of the field (optional)
      Returns:
      String
      Default:
      ""

    • pattern

      String pattern
      pattern that the formater will use to transform the data (optional)
      Returns:
      String
      Default:
      ""

    • timezone

      String timezone
      Timezone to be used.
      Returns:
      String timezone ID
      Default:
      ""

    • position

      int position
      Position of the field in the message generated - must be used when the position of the key/tag in the FIX message must be different
      Returns:
      int
      Default:
      0

    • precision

      int precision
      precision of the BigDecimal number to be created
      Returns:
      int
      Default:
      0

    • required

      boolean required
      Indicates if the field is mandatory
      Default:
      false

    • impliedDecimalSeparator

      boolean impliedDecimalSeparator
      Camel 2.11: Indicates if there is a decimal point implied at a specified location
      Default:
      false