Package io.micronaut.data.intercept.annotation

Annotation Interface DataMethod

@Retention(RUNTIME) @Target({METHOD,ANNOTATION_TYPE}) @Internal @Inherited public @interface DataMethod
Internal annotation used to configure execution handling for io.micronaut.data.runtime.intercept.DataIntroductionAdvice.
Since:
1.0
Author:
graemerocher

  • Field Details

    • NAME

      static final String NAME
      The annotation name.

    • META_MEMBER_PROCEDURE

      static final String META_MEMBER_PROCEDURE
      The member that holds the is procedure value.
      See Also:

    • META_MEMBER_EXPANDABLE_QUERY

      static final String META_MEMBER_EXPANDABLE_QUERY
      The member that holds expandable query parts.
      See Also:

    • META_MEMBER_EXPANDABLE_COUNT_QUERY

      static final String META_MEMBER_EXPANDABLE_COUNT_QUERY
      The member that holds expandable count query parts.
      See Also:

    • META_MEMBER_COUNT_QUERY

      static final String META_MEMBER_COUNT_QUERY
      The member that holds the count query.
      See Also:

    • META_MEMBER_RESULT_TYPE

      static final String META_MEMBER_RESULT_TYPE
      The member name that holds the result type.
      See Also:

    • META_MEMBER_RESULT_DATA_TYPE

      static final String META_MEMBER_RESULT_DATA_TYPE
      The member name that holds the result type.
      See Also:

    • META_MEMBER_ROOT_ENTITY

      static final String META_MEMBER_ROOT_ENTITY
      The member name that holds the root entity type.
      See Also:

    • META_MEMBER_INTERCEPTOR

      static final String META_MEMBER_INTERCEPTOR
      The member name that holds the interceptor type.
      See Also:

    • META_MEMBER_PARAMETER_BINDING

      @Deprecated(forRemoval=true) static final String META_MEMBER_PARAMETER_BINDING
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      The member name that holds parameter binding.
      See Also:

    • META_MEMBER_PARAMETER_BINDING_PATHS

      @Deprecated(forRemoval=true) static final String META_MEMBER_PARAMETER_BINDING_PATHS
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      The member name that holds parameter binding paths.
      See Also:

    • META_MEMBER_PARAMETER_AUTO_POPULATED_PROPERTY_PATHS

      @Deprecated(forRemoval=true) static final String META_MEMBER_PARAMETER_AUTO_POPULATED_PROPERTY_PATHS
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      The member name that holds parameter auto-populated property paths.
      See Also:

    • META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_PATHS

      @Deprecated(forRemoval=true) static final String META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_PATHS
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      The member name that holds parameter auto-populated property paths.
      See Also:

    • META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_INDEXES

      @Deprecated(forRemoval=true) static final String META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_INDEXES
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      The member name that holds parameter auto-populated property paths.
      See Also:

    • META_MEMBER_ID_TYPE

      static final String META_MEMBER_ID_TYPE
      The ID type.
      See Also:

    • META_MEMBER_PAGE_SIZE

      static final String META_MEMBER_PAGE_SIZE
      The parameter that holds the pageSize value.
      See Also:

    • META_MEMBER_PAGE_INDEX

      static final String META_MEMBER_PAGE_INDEX
      The parameter that holds the offset value.
      See Also:

    • META_MEMBER_ENTITY

      static final String META_MEMBER_ENTITY
      The parameter that references the entity.
      See Also:

    • META_MEMBER_ID

      static final String META_MEMBER_ID
      The parameter that references the ID.
      See Also:

    • META_MEMBER_DTO

      static final String META_MEMBER_DTO
      Does the query result in a DTO object.
      See Also:

    • META_MEMBER_OPTIMISTIC_LOCK

      static final String META_MEMBER_OPTIMISTIC_LOCK
      Does the query contains optimistic lock.
      See Also:

    • META_MEMBER_QUERY_BUILDER

      static final String META_MEMBER_QUERY_BUILDER
      The query builder to use.
      See Also:

    • META_MEMBER_RAW_QUERY

      static final String META_MEMBER_RAW_QUERY
      Whether the user is a raw user specified query.
      See Also:

    • META_MEMBER_RAW_COUNT_QUERY

      static final String META_MEMBER_RAW_COUNT_QUERY
      Whether the user is a raw user specified query.
      See Also:

    • META_MEMBER_PARAMETER_TYPE_DEFS

      @Deprecated(forRemoval=true) static final String META_MEMBER_PARAMETER_TYPE_DEFS
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      Meta member for storing the parameter type defs.
      See Also:

    • META_MEMBER_PARAMETER_CONVERTERS

      @Deprecated(forRemoval=true) static final String META_MEMBER_PARAMETER_CONVERTERS
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      Meta member for storing the parameter converters.
      See Also:

    • META_MEMBER_PARAMETERS

      static final String META_MEMBER_PARAMETERS
      Meta member for storing the parameters.
      See Also:

    • META_MEMBER_OPERATION_TYPE

      static final String META_MEMBER_OPERATION_TYPE
      The member name that holds the root entity type.
      See Also:

  • Element Details

    • interceptor

      Class<? extends DataInterceptor> interceptor
      Returns:
      The child interceptor to use for the method execution.

    • rootEntity

      Class<?> rootEntity
      The root entity this method applies to.
      Returns:
      The root entity
      Default:
      void.class

    • resultType

      Class<?> resultType
      The computed result type. This represents the type that is to be read from the database. For example for a List this would return the value of the generic type parameter E. Or for an entity result the return type itself.
      Returns:
      The result type
      Default:
      void.class

    • resultDataType

      DataType resultDataType
      Returns:
      The result data type.
      Default:
      OBJECT

    • idType

      Class<?> idType
      The identifier type for the method being executed.
      Returns:
      The ID type
      Default:
      java.io.Serializable.class

    • parameterBinding

      @Deprecated(forRemoval=true) io.micronaut.context.annotation.Property[] parameterBinding
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer used
      The parameter binding defines which method arguments bind to which query parameters. The Property.name() is used to define the query parameter name and the Property.value() is used to define method argument name to bind.
      Returns:
      The parameter binding.
      Default:
      {}

    • pageable

      String pageable
      The argument that defines the pageable object.
      Returns:
      The pageable.
      Default:
      ""

    • entity

      String entity
      The argument that represents the entity for save, update, query by example operations etc.
      Returns:
      The entity argument
      Default:
      ""

    • id

      String id
      The member that defines the ID for lookup, delete, update by ID.
      Returns:
      The ID
      Default:
      ""

    • pageSize

      int pageSize
      An explicit pageSize (in absence of a pageable).
      Returns:
      The pageSize
      Default:
      -1

    • pageIndex

      long pageIndex
      An explicit offset (in absence of a pageable).
      Returns:
      The offset
      Default:
      0L

    • parameters

      DataMethodQueryParameter[] parameters
      Returns:
      The query parameters
      Default:
      {}

    • procedure

      boolean procedure
      Returns:
      True if the method represents the procedure invocation.
      Since:
      4.2.0
      Default:
      false