Annotation Interface Embedded

@Documented @Retention(RUNTIME) @Target({ANNOTATION_TYPE,FIELD,METHOD}) public @interface Embedded
The annotation to configure a value object as embedded in the current table.

Depending on the value of onEmpty() the property is set to null or an empty instance in the case all embedded values are null when reading from the result set.

Since:
3.0
Author:
Christoph Strobl

  • Nested Class Summary

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

  • Required Element Summary

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    prefix
     

  • Element Details

    • onEmpty

      Embedded.OnEmpty onEmpty
      Set the load strategy for the embedded object if all contained fields yield null values.

      @Embedded.Nullable and @Embedded.Empty offer shortcuts for this.

      Returns:
      never null.

    • prefix

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