Package io.micronaut.data.intercept.annotation

Annotation Type DataMethodQueryParameter

  • @Retention(RUNTIME)
@Target({METHOD,ANNOTATION_TYPE})
@Internal
@Inherited
public @interface DataMethodQueryParameter
    Internal annotation representing query parameter binding.
    Since:
    3.2

    • Field Detail

      • META_MEMBER_NAME

        static final java.lang.String META_MEMBER_NAME
        The member name that holds an optional query parameter name.

      • META_MEMBER_DATA_TYPE

        static final java.lang.String META_MEMBER_DATA_TYPE
        The member name that holds the data type.

      • META_MEMBER_PARAMETER_INDEX

        static final java.lang.String META_MEMBER_PARAMETER_INDEX
        The member name that holds the parameter index.

      • META_MEMBER_PARAMETER_BINDING_PATH

        static final java.lang.String META_MEMBER_PARAMETER_BINDING_PATH
        The member name that holds the parameter binding path.

      • META_MEMBER_PROPERTY

        static final java.lang.String META_MEMBER_PROPERTY
        The member name that holds the property name.

      • META_MEMBER_PROPERTY_PATH

        static final java.lang.String META_MEMBER_PROPERTY_PATH
        The member name that holds the property path.

      • META_MEMBER_CONVERTER

        static final java.lang.String META_MEMBER_CONVERTER
        The member name that holds the converter class.

      • META_MEMBER_AUTO_POPULATED

        static final java.lang.String META_MEMBER_AUTO_POPULATED
        The member name that holds the auto-populated value.

      • META_MEMBER_REQUIRES_PREVIOUS_POPULATED_VALUES

        static final java.lang.String META_MEMBER_REQUIRES_PREVIOUS_POPULATED_VALUES
        The member name that holds requiresPreviousPopulatedValue.

      • META_MEMBER_EXPANDABLE

        static final java.lang.String META_MEMBER_EXPANDABLE
        The member name that holds expandable.

    • Element Detail

      • name

        java.lang.String name
        Returns:
        The query parameter name
        Default:
        ""

      • dataType

        DataType dataType
        Returns:
        The data type.
        Default:
        io.micronaut.data.model.DataType.OBJECT

      • parameterIndex

        int parameterIndex
        Returns:
        The parameter index
        Default:
        -1

      • parameterBindingPath

        java.lang.String[] parameterBindingPath
        Returns:
        The parameter binding property path
        Default:
        {}

      • property

        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

        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

        java.lang.Class[] converter
        Returns:
        The property converter class
        Default:
        {}

      • autoPopulated

        boolean autoPopulated
        Returns:
        true if property is auto-populated
        Default:
        false

      • requiresPreviousPopulatedValue

        boolean requiresPreviousPopulatedValue
        Returns:
        true if the value has to be previous populated value and not a newly generated.
        Default:
        false