Package io.micronaut.data.model.runtime

Interface QueryParameterBinding

  • All Known Implementing Classes:
    StoredQueryParameter
    public interface QueryParameterBinding
    The query parameter binding.
    Since:
    3.2
    Author:
    Denis Stepanov

    • Method Detail

      • getName

        @Nullable
default java.lang.String getName()
        Returns:
        The name of the parameter

      • getRequiredName

        @NonNull
default java.lang.String getRequiredName()
        Returns:
        The required name of the parameter or throws exception

      • getDataType

        @Nullable
default DataType getDataType()
        Returns:
        The data type

      • getParameterConverterClass

        @Nullable
default java.lang.Class<?> getParameterConverterClass()
        Returns:
        The parameter converter class

      • getParameterIndex

        default int getParameterIndex()
        Returns:
        The parameter index

      • getParameterBindingPath

        @Nullable
default java.lang.String[] getParameterBindingPath()
        Returns:
        The parameter binding property path.

      • getPropertyPath

        @Nullable
default java.lang.String[] getPropertyPath()
        Returns:
        The property path.

      • getRequiredPropertyPath

        @NonNull
default java.lang.String[] getRequiredPropertyPath()
        Returns:
        The required property path or throws and exception.

      • isAutoPopulated

        default boolean isAutoPopulated()
        Returns:
        if property is auto-populated

      • isRequiresPreviousPopulatedValue

        default boolean isRequiresPreviousPopulatedValue()
        Returns:
        if property is auto-populated and binding requires previous value to be set.

      • getPreviousPopulatedValueParameter

        @Nullable
default QueryParameterBinding getPreviousPopulatedValueParameter()
        Returns:
        The previous value of the auto-populated property for cases when the property is mapped to the method parameter.

      • isExpandable

        default boolean isExpandable()
        Returns:
        Is expandable parameter

      • getValue

        @Nullable
default java.lang.Object getValue()
        The constant runtime value for the parameter.
        Returns:
        the value or null