Annotation Interface MapField


@Target({FIELD,RECORD_COMPONENT}) @Retention(RUNTIME) public @interface MapField
Configures how a field is represented in object-to-map mapping.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends MapTypeConverter<?>>
    Optional converter class for this field/component.
    boolean
    Excludes field from mapping when true.
    Output key for the mapped field.
  • Element Details

    • key

      String key
      Output key for the mapped field. Blank value means field name.
      Default:
      ""
    • ignore

      boolean ignore
      Excludes field from mapping when true.
      Default:
      false
    • converter

      Class<? extends MapTypeConverter<?>> converter
      Optional converter class for this field/component. Use MapTypeConverter.DefaultConverter to indicate "no explicit converter".
      Default:
      io.github.connellite.reflection.MapTypeConverter.DefaultConverter.class