Package io.micronaut.data.model.runtime

Interface QueryParameterBinding

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

  • Method Details

    • getName

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

    • getRequiredName

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

    • getDataType

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

    • getJsonDataType

      @Nullable default @Nullable JsonDataType getJsonDataType()
      Returns:
      The JSON representation type if data type is JSON, default JsonDataType.DEFAULT

    • getParameterConverterClass

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

    • getParameterIndex

      default int getParameterIndex()
      Returns:
      The parameter index

    • getParameterBindingPath

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

    • getPropertyPath

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

    • getRequiredPropertyPath

      @NonNull default @NonNull 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 @Nullable 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 @Nullable Object getValue()
      The constant runtime value for the parameter.
      Returns:
      the value or null

    • isExpression

      default boolean isExpression()
      Returns:
      Is expression value
      Since:
      4.5.0

    • getRole

      @Nullable default @Nullable String getRole()
      Returns:
      The parameter in role
      Since:
      4.10

    • getTableAlias

      @Nullable default @Nullable String getTableAlias()
      Returns:
      The table alias
      Since:
      4.10