Package io.micronaut.data.runtime.query.internal

Class StoredQueryParameter

java.lang.Object

io.micronaut.data.runtime.query.internal.StoredQueryParameter

All Implemented Interfaces:

QueryParameterBinding

@Internal
public final class StoredQueryParameter
extends Object
implements QueryParameterBinding

The stored query parameter.

Since:

3.3

Author:

Denis Stepanov

Method Summary

Modifier and Type	Method	Description
DataType	getDataType()
JsonDataType	getJsonDataType()
String	getName()
String[]	getParameterBindingPath()
Class<?>	getParameterConverterClass()
int	getParameterIndex()
QueryParameterBinding	getPreviousPopulatedValueParameter()
String[]	getPropertyPath()
String	getRole()
String	getTableAlias()
Object	getValue()	The constant runtime value for the parameter.
boolean	isAutoPopulated()
boolean	isExpandable()
boolean	isExpression()
boolean	isRequiresPreviousPopulatedValue()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.micronaut.data.model.runtime.QueryParameterBinding

getRequiredName, getRequiredPropertyPath

Method Details

getName

public String getName()

Specified by:

getName in interface QueryParameterBinding

Returns:

The name of the parameter

getDataType

public DataType getDataType()

Specified by:

getDataType in interface QueryParameterBinding

Returns:

The data type

getJsonDataType

public JsonDataType getJsonDataType()

Specified by:

getJsonDataType in interface QueryParameterBinding

Returns:

The JSON representation type if data type is JSON, default JsonDataType.DEFAULT

getParameterConverterClass

public Class<?> getParameterConverterClass()

Specified by:

getParameterConverterClass in interface QueryParameterBinding

Returns:

The parameter converter class

getParameterIndex

public int getParameterIndex()

Specified by:

getParameterIndex in interface QueryParameterBinding

Returns:

The parameter index

getParameterBindingPath

public String[] getParameterBindingPath()

Specified by:

getParameterBindingPath in interface QueryParameterBinding

Returns:

The parameter binding property path.

getPropertyPath

public String[] getPropertyPath()

Specified by:

getPropertyPath in interface QueryParameterBinding

Returns:

The property path.

isAutoPopulated

public boolean isAutoPopulated()

Specified by:

isAutoPopulated in interface QueryParameterBinding

Returns:

if property is auto-populated

isRequiresPreviousPopulatedValue

public boolean isRequiresPreviousPopulatedValue()

Specified by:

isRequiresPreviousPopulatedValue in interface QueryParameterBinding

Returns:

if property is auto-populated and binding requires previous value to be set.

getPreviousPopulatedValueParameter

public QueryParameterBinding getPreviousPopulatedValueParameter()

Specified by:

getPreviousPopulatedValueParameter in interface QueryParameterBinding

Returns:

The previous value of the auto-populated property for cases when the property is mapped to the method parameter.

isExpandable

public boolean isExpandable()

Specified by:

isExpandable in interface QueryParameterBinding

Returns:

Is expandable parameter

isExpression

public boolean isExpression()

Specified by:

isExpression in interface QueryParameterBinding

Returns:

Is expression value

getValue

public Object getValue()

Description copied from interface: QueryParameterBinding

The constant runtime value for the parameter.

Specified by:

getValue in interface QueryParameterBinding

Returns:

the value or null

getRole

public String getRole()

Specified by:

getRole in interface QueryParameterBinding

Returns:

The parameter in role

getTableAlias

public String getTableAlias()

Specified by:

getTableAlias in interface QueryParameterBinding

Returns:

The table alias

toString

public String toString()

Overrides:

toString in class Object