DataMethod (javadoc 3.0.1 API)

@Retention(value=RUNTIME)
 @Target(value={METHOD,ANNOTATION_TYPE})
 @Internal
 @Inherited
public @interface DataMethod

Internal annotation used to configure execution handling for DataIntroductionAdvice.

Since:: 1.0
Author:: graemerocher

Field Summary

Fields
Modifier and Type	Fields and Description
`static java.lang.String`	`META_MEMBER_COUNT_PARAMETERS` The member that holds the count parameters.
`static java.lang.String`	`META_MEMBER_COUNT_QUERY` The member that holds the count query.
`static java.lang.String`	`META_MEMBER_DTO` Does the query result in a DTO object.
`static java.lang.String`	`META_MEMBER_ENTITY` The parameter that references the entity.
`static java.lang.String`	`META_MEMBER_ID` The parameter that references the ID.
`static java.lang.String`	`META_MEMBER_ID_TYPE` The ID type.
`static java.lang.String`	`META_MEMBER_INTERCEPTOR` The member name that holds the interceptor type.
`static java.lang.String`	`META_MEMBER_OPTIMISTIC_LOCK` Does the query contains optimistic lock.
`static java.lang.String`	`META_MEMBER_PAGE_INDEX` The parameter that holds the offset value.
`static java.lang.String`	`META_MEMBER_PAGE_SIZE` The parameter that holds the pageSize value.
`static java.lang.String`	`META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_INDEXES` The member name that holds parameter auto populated property paths.
`static java.lang.String`	`META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_PATHS` The member name that holds parameter auto populated property paths.
`static java.lang.String`	`META_MEMBER_PARAMETER_AUTO_POPULATED_PROPERTY_PATHS` The member name that holds parameter auto populated property paths.
`static java.lang.String`	`META_MEMBER_PARAMETER_BINDING` The member name that holds parameter binding.
`static java.lang.String`	`META_MEMBER_PARAMETER_BINDING_PATHS` The member name that holds parameter binding paths.
`static java.lang.String`	`META_MEMBER_PARAMETER_TYPE_DEFS` Meta member for storing the parameter type defs.
`static java.lang.String`	`META_MEMBER_QUERY_BUILDER` The query builder to use.
`static java.lang.String`	`META_MEMBER_RAW_COUNT_QUERY` Whether the user is a raw user specified query.
`static java.lang.String`	`META_MEMBER_RAW_QUERY` Whether the user is a raw user specified query.
`static java.lang.String`	`META_MEMBER_RESULT_DATA_TYPE` The member name that holds the result type.
`static java.lang.String`	`META_MEMBER_RESULT_TYPE` The member name that holds the result type.
`static java.lang.String`	`META_MEMBER_ROOT_ENTITY` The member name that holds the root entity type.

Required Element Summary

Required Elements
Modifier and Type Required Element and Description

java.lang.Class<? extends DataInterceptor> interceptor

Required Elements
Modifier and Type	Required Element and Description
`java.lang.Class<? extends DataInterceptor>`	`interceptor`

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`java.lang.String`	`entity` The argument that represents the entity for save, update, query by example operations etc.
`java.lang.String`	`id` The member that defines the ID for lookup, delete, update by ID.
`java.lang.Class<?>`	`idType` The identifier type for the method being executed.
`java.lang.String`	`pageable` The argument that defines the pageable object.
`long`	`pageIndex` An explicit offset (in absence of a pageable).
`int`	`pageSize` An explicit pageSize (in absence of a pageable).
`io.micronaut.context.annotation.Property[]`	`parameterBinding` The parameter binding defines which method arguments bind to which query parameters.
`DataType`	`resultDataType`
`java.lang.Class<?>`	`resultType` The computed result type.
`java.lang.Class<?>`	`rootEntity` The root entity this method applies to.

- Field Detail
  - META_MEMBER_COUNT_QUERY
```
public static final java.lang.String META_MEMBER_COUNT_QUERY
```
    The member that holds the count query.
- - META_MEMBER_COUNT_PARAMETERS
```
public static final java.lang.String META_MEMBER_COUNT_PARAMETERS
```
    The member that holds the count parameters.
- - META_MEMBER_RESULT_TYPE
```
public static final java.lang.String META_MEMBER_RESULT_TYPE
```
    The member name that holds the result type.
- - META_MEMBER_RESULT_DATA_TYPE
```
public static final java.lang.String META_MEMBER_RESULT_DATA_TYPE
```
    The member name that holds the result type.
- - META_MEMBER_ROOT_ENTITY
```
public static final java.lang.String META_MEMBER_ROOT_ENTITY
```
    The member name that holds the root entity type.
- - META_MEMBER_INTERCEPTOR
```
public static final java.lang.String META_MEMBER_INTERCEPTOR
```
    The member name that holds the interceptor type.
- - META_MEMBER_PARAMETER_BINDING
```
public static final java.lang.String META_MEMBER_PARAMETER_BINDING
```
    The member name that holds parameter binding.
- - META_MEMBER_PARAMETER_BINDING_PATHS
```
public static final java.lang.String META_MEMBER_PARAMETER_BINDING_PATHS
```
    The member name that holds parameter binding paths.
- - META_MEMBER_PARAMETER_AUTO_POPULATED_PROPERTY_PATHS
```
public static final java.lang.String META_MEMBER_PARAMETER_AUTO_POPULATED_PROPERTY_PATHS
```
    The member name that holds parameter auto populated property paths.
- - META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_PATHS
```
public static final java.lang.String META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_PATHS
```
    The member name that holds parameter auto populated property paths.
- - META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_INDEXES
```
public static final java.lang.String META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_INDEXES
```
    The member name that holds parameter auto populated property paths.
- - META_MEMBER_ID_TYPE
```
public static final java.lang.String META_MEMBER_ID_TYPE
```
    The ID type.
- - META_MEMBER_PAGE_SIZE
```
public static final java.lang.String META_MEMBER_PAGE_SIZE
```
    The parameter that holds the pageSize value.
- - META_MEMBER_PAGE_INDEX
```
public static final java.lang.String META_MEMBER_PAGE_INDEX
```
    The parameter that holds the offset value.
- - META_MEMBER_ENTITY
```
public static final java.lang.String META_MEMBER_ENTITY
```
    The parameter that references the entity.
- - META_MEMBER_ID
```
public static final java.lang.String META_MEMBER_ID
```
    The parameter that references the ID.
- - META_MEMBER_DTO
```
public static final java.lang.String META_MEMBER_DTO
```
    Does the query result in a DTO object.
- - META_MEMBER_OPTIMISTIC_LOCK
```
public static final java.lang.String META_MEMBER_OPTIMISTIC_LOCK
```
    Does the query contains optimistic lock.
- - META_MEMBER_QUERY_BUILDER
```
public static final java.lang.String META_MEMBER_QUERY_BUILDER
```
    The query builder to use.
- - META_MEMBER_RAW_QUERY
```
public static final java.lang.String META_MEMBER_RAW_QUERY
```
    Whether the user is a raw user specified query.
- - META_MEMBER_RAW_COUNT_QUERY
```
public static final java.lang.String META_MEMBER_RAW_COUNT_QUERY
```
    Whether the user is a raw user specified query.
- - META_MEMBER_PARAMETER_TYPE_DEFS
```
public static final java.lang.String META_MEMBER_PARAMETER_TYPE_DEFS
```
    Meta member for storing the parameter type defs.
- Element Detail
  - interceptor
```
public abstract java.lang.Class<? extends DataInterceptor> interceptor
```
    Returns:
    
    The child interceptor to use for the method execution.
- - rootEntity
```
public abstract java.lang.Class<?> rootEntity
```
    The root entity this method applies to.
    
    Returns:
    
    The root entity
    
    Default:
    
    void.class
- - resultType
```
public abstract java.lang.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
```
public abstract DataType resultDataType
```
    Returns:
    
    The result data type.
    
    Default:
    
    io.micronaut.data.model.DataType.OBJECT
- - idType
```
public abstract java.lang.Class<?> idType
```
    The identifier type for the method being executed.
    
    Returns:
    
    The ID type
    
    Default:
    
    java.io.Serializable.class
- - parameterBinding
```
public abstract io.micronaut.context.annotation.Property[] parameterBinding
```
    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
```
public abstract java.lang.String pageable
```
    The argument that defines the pageable object.
    
    Returns:
    
    The pageable.
    
    Default:
    
    ""
- - entity
```
public abstract java.lang.String entity
```
    The argument that represents the entity for save, update, query by example operations etc.
    
    Returns:
    
    The entity argument
    
    Default:
    
    ""
- - id
```
public abstract java.lang.String id
```
    The member that defines the ID for lookup, delete, update by ID.
    
    Returns:
    
    The ID
    
    Default:
    
    ""
- - pageSize
```
public abstract int pageSize
```
    An explicit pageSize (in absence of a pageable).
    
    Returns:
    
    The pageSize
    
    Default:
    
    -1
- - pageIndex
```
public abstract long pageIndex
```
    An explicit offset (in absence of a pageable).
    
    Returns:
    
    The offset
    
    Default:
    
    0L

Annotation Type DataMethod

Field Summary

Required Element Summary

Optional Element Summary

Field Detail

META_MEMBER_COUNT_QUERY

META_MEMBER_COUNT_PARAMETERS

META_MEMBER_RESULT_TYPE

META_MEMBER_RESULT_DATA_TYPE

META_MEMBER_ROOT_ENTITY

META_MEMBER_INTERCEPTOR

META_MEMBER_PARAMETER_BINDING

META_MEMBER_PARAMETER_BINDING_PATHS

META_MEMBER_PARAMETER_AUTO_POPULATED_PROPERTY_PATHS

META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_PATHS

META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_INDEXES

META_MEMBER_ID_TYPE

META_MEMBER_PAGE_SIZE

META_MEMBER_PAGE_INDEX

META_MEMBER_ENTITY

META_MEMBER_ID

META_MEMBER_DTO

META_MEMBER_OPTIMISTIC_LOCK

META_MEMBER_QUERY_BUILDER

META_MEMBER_RAW_QUERY

META_MEMBER_RAW_COUNT_QUERY

META_MEMBER_PARAMETER_TYPE_DEFS

Element Detail

interceptor

rootEntity

resultType

resultDataType

idType

parameterBinding

pageable

entity

id

pageSize

pageIndex