Module io.avaje.jsonb
Package io.avaje.jsonb

Annotation Type CustomAdapter

@Target(TYPE) public @interface CustomAdapter
Marks a type as a basic user-provided JsonAdapter to be registered automatically.

A custom adapter registered using this annotation must have a public constructor accepting a Jsonb instance (or a public static JsonAdapter.Factory FACTORY field for generic adapters), and must directly implement the JsonAdapter Interface.

Example:

invalid input: '{@code
 @CustomAdapter
 public class CustomJsonAdapter implements JsonAdapter<CustomType> {

   private final JsonAdapter<String> stringJsonAdapter;
   private final PropertyNames names;

   public CustomJsonAdapter(Jsonb jsonb) {
     // use the jsonb adapter method to get type serializers
     stringJsonAdapter = jsonb.adapter(String.class);
     // add serialization names
     jsonb.properties("prop1","prop2", ...);
   }
 ...

 }</pre>

 <h3>Example of Generic Adapter:</h3>

 <pre>{@code

 @CustomAdapter(isGeneric=true)
 public class CustomJsonAdapter<T> implements JsonAdapter<GenericType<T>> {

   private final JsonAdapter<T> genericTypeAdapter;
   private final PropertyNames names;

   public static final JsonAdapter.Factory FACTORY = (type, jsonb) -> {
       if (Types.isGenericTypeOf(type, GenericType.class)) {
         return new CustomJsonAdapter<>(jsonb, Types.typeArguments(type))
       }
       return null;
     };

   public CustomJsonAdapter(Jsonb jsonb, Type[] types) {
     //use the jsonb adapter method to get type serializers
     genericTypeAdapter = jsonb.adapter(types[0]);
     //add serialization names
     jsonb.properties("prop1","prop2", ...);
   }
 ...

 }</pre>'

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    isGeneric
    Set to true when the adapter is for a type that uses generics.

  • Element Details

    • isGeneric

      boolean isGeneric
      Set to true when the adapter is for a type that uses generics.
      Default:
      false