Annotation Interface DocumentValueIgnore

@Documented @Retention(RUNTIME) @Target({TYPE,FIELD}) public @interface DocumentValueIgnore
Annotation to indicate that the annotated field or type should be ignored during tree serialisation or deserialization. While this annotation should be supported by all document type implementations, there is no guarantee that this is the case.
Since:
4.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    DocumentValueIgnore.Direction
    Represents the possible document serialisation directions.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    @NonNull DocumentValueIgnore.Direction[]
    value
    Get the serialisation direction(s) when the field should be ignored.

  • Element Details

    • value

      @NonNull @NonNull DocumentValueIgnore.Direction[] value
      Get the serialisation direction(s) when the field should be ignored. This value defaults to both directions, meaning that the field is neither serialized nor deserialized.
      Returns:
      the serialisation direction(s) when the field should be ignored.
      Default:
      {SERIALIZE, DESERIALIZE}