io.micronaut.data.intercept.annotation

Annotation Type DataMethodQueryParameter

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

Internal annotation representing query parameter binding.

Since:

3.2

Author:

Denis Stepanov

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	META_MEMBER_AUTO_POPULATED The member name that holds the auto-populated value.
static java.lang.String	META_MEMBER_CONVERTER The member name that holds the converter class.
static java.lang.String	META_MEMBER_DATA_TYPE The member name that holds the data type.
static java.lang.String	META_MEMBER_EXPANDABLE The member name that holds expandable.
static java.lang.String	META_MEMBER_NAME The member name that holds an optional query parameter name.
static java.lang.String	META_MEMBER_PARAMETER_BINDING_PATH The member name that holds the parameter binding path.
static java.lang.String	META_MEMBER_PARAMETER_INDEX The member name that holds the parameter index.
static java.lang.String	META_MEMBER_PROPERTY The member name that holds the property name.
static java.lang.String	META_MEMBER_PROPERTY_PATH The member name that holds the property path.
static java.lang.String	META_MEMBER_REQUIRES_PREVIOUS_POPULATED_VALUES The member name that holds requiresPreviousPopulatedValue.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoPopulated
java.lang.Class[]	converter
DataType	dataType
java.lang.String	name
java.lang.String[]	parameterBindingPath
int	parameterIndex
java.lang.String	property The property name that this parameter is representing.
java.lang.String[]	propertyPath The path to the property that this parameter is representing.
boolean	requiresPreviousPopulatedValue

Field Detail

META_MEMBER_NAME

public static final java.lang.String META_MEMBER_NAME

The member name that holds an optional query parameter name.

META_MEMBER_DATA_TYPE

public static final java.lang.String META_MEMBER_DATA_TYPE

The member name that holds the data type.

META_MEMBER_PARAMETER_INDEX

public static final java.lang.String META_MEMBER_PARAMETER_INDEX

The member name that holds the parameter index.

META_MEMBER_PARAMETER_BINDING_PATH

public static final java.lang.String META_MEMBER_PARAMETER_BINDING_PATH

The member name that holds the parameter binding path.

META_MEMBER_PROPERTY

public static final java.lang.String META_MEMBER_PROPERTY

The member name that holds the property name.

META_MEMBER_PROPERTY_PATH

public static final java.lang.String META_MEMBER_PROPERTY_PATH

The member name that holds the property path.

META_MEMBER_CONVERTER

public static final java.lang.String META_MEMBER_CONVERTER

The member name that holds the converter class.

META_MEMBER_AUTO_POPULATED

public static final java.lang.String META_MEMBER_AUTO_POPULATED

The member name that holds the auto-populated value.

META_MEMBER_REQUIRES_PREVIOUS_POPULATED_VALUES

public static final java.lang.String META_MEMBER_REQUIRES_PREVIOUS_POPULATED_VALUES

The member name that holds requiresPreviousPopulatedValue.

META_MEMBER_EXPANDABLE

public static final java.lang.String META_MEMBER_EXPANDABLE

The member name that holds expandable.

Element Detail

name

public abstract java.lang.String name

Returns:

The query parameter name

Default:

""

dataType

public abstract DataType dataType

Returns:

The data type.

Default:

io.micronaut.data.model.DataType.OBJECT

parameterIndex

public abstract int parameterIndex

Returns:

The parameter index

Default:

-1

parameterBindingPath

public abstract java.lang.String[] parameterBindingPath

Returns:

The parameter binding property path

Default:

{}

property

public abstract java.lang.String property

The property name that this parameter is representing. If property is from an association or an embedded entity the value would be empty and `propertyPath` would be set instead.

Returns:

The property name.

Default:

""

propertyPath

public abstract java.lang.String[] propertyPath

The path to the property that this parameter is representing. Only set if the property is from an association or from an embedded entity.

Returns:

The property path.

Default:

{}

converter

public abstract java.lang.Class[] converter

Returns:

The property converter class

Default:

{}

autoPopulated

public abstract boolean autoPopulated

Returns:

true if property is auto-populated

Default:

false

requiresPreviousPopulatedValue

public abstract boolean requiresPreviousPopulatedValue

Returns:

true if the value has to be previous populated value and not a newly generated.

Default:

false