Annotation Interface Unwrapped

@Documented @Retention(RUNTIME) @Target({ANNOTATION_TYPE,FIELD,METHOD}) public @interface Unwrapped
The annotation to configure a value object as flattened out in the target document.
Depending on the value of onEmpty() the property is set to null or an empty instance in the case all unwrapped values are null when reading from the result set.
Since:
3.2
Author:
Christoph Strobl

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    Unwrapped.Empty
    Shortcut for an empty unwrapped property.
    static @interface 
    Unwrapped.Nullable
    Shortcut for a nullable unwrapped property.
    static enum 
    Unwrapped.OnEmpty
    Load strategy to be used onEmpty().

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Unwrapped.OnEmpty
    onEmpty
    Set the load strategy for the unwrapped object if all contained fields yield null values.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    prefix
     

  • Element Details

    • onEmpty

      Unwrapped.OnEmpty onEmpty
      Set the load strategy for the unwrapped object if all contained fields yield null values.
      @Unwrapped.Nullable and @Unwrapped.Empty offer shortcuts for this.
      Returns:
      never invalid input: '{@link /*missing*/}' null.

    • prefix

      String prefix
      Returns:
      prefix for columns in the unwrapped value object. An empty String by default.
      Default:
      ""