Annotation Interface Field

@Documented @Retention(RUNTIME) @Target({FIELD,METHOD,ANNOTATION_TYPE}) public @interface Field
Annotation to define custom metadata for document fields.
Author:
Oliver Gierke, Christoph Strobl

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    The key to be used to store the field inside the document.
    int
    order
    The order in which various fields shall be stored.
    String
    value
    The key to be used to store the field inside the document.

  • Element Details

    • value

      @AliasFor("name") String value
      The key to be used to store the field inside the document. Alias for name().
      Returns:
      an empty String by default.
      Default:
      ""

    • name

      @AliasFor("value") String name
      The key to be used to store the field inside the document. Alias for value().
      Returns:
      an empty String by default.
      Default:
      ""

    • order

      int order
      The order in which various fields shall be stored. Has to be a positive integer.
      Returns:
      the order the field shall have in the document or -1 if undefined.
      Default:
      2147483647