Module jakarta.json.bind
Package jakarta.json.bind.annotation

Annotation Type JsonbProperty

  • @JsonbAnnotation
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE,METHOD,FIELD,PARAMETER})
public @interface JsonbProperty

    Allows customization of field (or JavaBean property) name.This name is used either in serialization or in deserialization.

    Usage

    The @JsonbProperty annotation can be used with the following program elements:

    • a JavaBean property
    • field
    • parameter
    Since:
    JSON Binding 1.0

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean nillable
      Deprecated.
      Please use JsonbNillable as another annotation instead.
      String value
      Customized name of the field (or JavaBean property).

    • Element Detail

      • value

        String value
        Customized name of the field (or JavaBean property).
        Returns:
        Customized property name.
        Default:
        ""

      • nillable

        @Deprecated(since="2.1")
boolean nillable
        Deprecated.
        Please use JsonbNillable as another annotation instead. This option will be removed in the future.
        Switches on/off serialization of null values.
        Returns:
        True if field with null value should be serialized as key/value pair into JSON with null value.
        Default:
        false