Annotation Type JsonAppend.Prop

Enclosing class:
JsonAppend
public static @interface JsonAppend.Prop
Definition of a single general virtual property.
Since:
2.5

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends VirtualBeanPropertyWriter>
    value
    Actual implementation class (a subtype of VirtualBeanPropertyWriter) of the property to instantiate (using the no-argument default constructor).

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    com.fasterxml.jackson.annotation.JsonInclude.Include
    include
    When to include value of the property.
    String
    name
    Name of the property to possibly use for serializing (although implementation may choose to not use this information).
    String
    namespace
    Optional namespace to use along with name(); only relevant for data formats that use namespaces (like XML).
    boolean
    required
    Metadata about property, similar to JsonProperty.required().
    Class<?>
    type
    Nominal type of the property.

  • Element Details

    • value

      Class<? extends VirtualBeanPropertyWriter> value
      Actual implementation class (a subtype of VirtualBeanPropertyWriter) of the property to instantiate (using the no-argument default constructor).

    • name

      String name
      Name of the property to possibly use for serializing (although implementation may choose to not use this information).
      Default:
      ""

    • namespace

      String namespace
      Optional namespace to use along with name(); only relevant for data formats that use namespaces (like XML).
      Default:
      ""

    • include

      com.fasterxml.jackson.annotation.JsonInclude.Include include
      When to include value of the property. Default value indicates that property should only be written if specified attribute has a non-null value. As with other properties, actual property implementation may or may not choose to use this inclusion information.
      Default:
      NON_NULL

    • required

      boolean required
      Metadata about property, similar to JsonProperty.required().
      Default:
      false

    • type

      Class<?> type
      Nominal type of the property. Passed as type information for related virtual objects, and may (or may not be) used by implementation for choosing serializer to use.
      Default:
      java.lang.Object.class