Module com.fasterxml.jackson.annotation
Package com.fasterxml.jackson.annotation

Annotation Interface JsonAnyGetter

@Target({ANNOTATION_TYPE,METHOD,FIELD}) @Retention(RUNTIME) public @interface JsonAnyGetter
Marker annotation that can be used to define a non-static, no-argument method to be an "any getter"; accessor for getting a set of key/value pairs, to be serialized as part of containing POJO (similar to unwrapping) along with regular property values it has. This typically serves as a counterpart to "any setter" mutators (see JsonAnySetter). Note that the return type of annotated methods must be Map).

As with JsonAnySetter, only one property should be annotated with this annotation; if multiple methods are annotated, an exception may be thrown.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    enabled
    Optional argument that defines whether this annotation is active or not.

  • Element Details

    • enabled

      boolean enabled
      Optional argument that defines whether this annotation is active or not. The only use for value 'false' if for overriding purposes. Overriding may be necessary when used with "mix-in annotations" (aka "annotation overrides"). For most cases, however, default value of "true" is just fine and should be omitted.
      Returns:
      True if annotation is enabled (normal case); false if it is to be ignored (only useful for mix-in annotations to "mask" annotation
      Default:
      true