Package io.micronaut.data.annotation

Annotation Type Join

  • @Retention(RUNTIME)
@Target({ANNOTATION_TYPE,TYPE,FIELD,METHOD})
@Repeatable(JoinSpecifications.class)
public @interface Join
    A @Join defines how a join for a particular association path should be generated.
    Since:
    1.0
    Author:
    graemerocher

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value  

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String alias  
      Join.Type type  

    • Element Detail

      • value

        java.lang.String value
        Returns:
        The path to join.

      • type

        Join.Type type
        Returns:
        The join type. For JPA this is JOIN FETCH.
        Default:
        io.micronaut.data.annotation.Join.Type.FETCH

      • alias

        java.lang.String alias
        Returns:
        The alias prefix to use for the join
        Default:
        ""