Package io.micronaut.data.annotation

Annotation Interface TypeRole

@Retention(RUNTIME) @Target({METHOD,FIELD,ANNOTATION_TYPE}) @Documented @Inherited public @interface TypeRole
A type role indicates a method element in a repository that plays a role in query execution and should not be factored into query calculation but instead made available at runtime using the specified role name.

This is used for example to configure a Pageable object to be handled differently to other query arguments.

The parameter names of each role can be resolved from the MethodInvocationContext as a member of the DataMethod annotation where the member name is the role name.

Since:
1.0.0
Author:
graemerocher

  • Field Details

  • Element Details

    • role

      String role
      The name of the role.
      Returns:
      The role name

    • type

      Class<?> type
      The parameter type.
      Returns:
      The parameter type