Package io.micronaut.data.model.query.builder

Interface QueryParameterBinding

All Known Implementing Classes:
AdditionalParameterBinding
@Internal public interface QueryParameterBinding
Query parameter binding, represents the data needed to bind a property to the query parameter.
Since:
2.4.0
Author:
Denis Stepanov

  • Method Details

    • getName

      String getName()
      Returns:
      The parameter name.

    • getKey

      String getKey()
      Returns:
      The key represents the placeholder value in the query (usually it's ?).

    • getDataType

      DataType getDataType()
      Returns:
      The data type

    • getJsonDataType

      default JsonDataType getJsonDataType()
      Returns:
      The json representation data type if getDataType is DataType.JSON and is annotated with JsonRepresentation annotation

    • getConverterClassName

      @Nullable default @Nullable String getConverterClassName()
      Returns:
      The converter class name

    • getParameterIndex

      default int getParameterIndex()
      Returns:
      The parameter index

    • getParameterBindingPath

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

    • getPropertyPath

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

    • isAutoPopulated

      default boolean isAutoPopulated()
      Returns:
      Is auto populated

    • isRequiresPreviousPopulatedValue

      default boolean isRequiresPreviousPopulatedValue()
      Returns:
      Is requires previous populated value

    • isExpandable

      default boolean isExpandable()
      Returns:
      Is expandable parameter

    • getValue

      @Nullable default @Nullable Object getValue()
      The constant runtime value.
      Returns:
      The value or null
      Since:
      3.5.0

    • isExpression

      @Nullable default @io.micronaut.core.annotation.Nullable boolean isExpression()
      The constant runtime value.
      Returns:
      The value or null
      Since:
      4.5.0

    • getRole

      @Nullable default @Nullable String getRole()
      The role of the parameter.
      Returns:
      The role name or null
      Since:
      4.10

    • getTableAlias

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