Package io.micronaut.data.model.query
Interface BindingParameter.BindingContext
- Enclosing interface:
- BindingParameter
public static interface BindingParameter.BindingContext
The binding context.
Additional properties are used to map binding parameter path. Example method `findByAuthor(author)` incoming method parameter property path would be `author` and query parameter property path `author.id`.
-
Method Summary
Modifier and TypeMethodDescriptioncreate()
Create new context.@NonNull BindingParameter.BindingContext
Mark the property as expandable.@Nullable PersistentPropertyPath
int
getIndex()
The position of the parameter in the query.@Nullable String
getName()
@Nullable PersistentPropertyPath
@NonNull BindingParameter.BindingContext
incomingMethodParameterProperty
(@Nullable PersistentPropertyPath propertyPath) The property that represents incoming method parameter property.@NonNull BindingParameter.BindingContext
index
(int index) The index of the parameter in the query.boolean
@NonNull BindingParameter.BindingContext
The name of the parameter in the query.@NonNull BindingParameter.BindingContext
outgoingQueryParameterProperty
(@Nullable PersistentPropertyPath propertyPath) The property that represents outgoing query parameter property.
-
Method Details
-
create
Create new context.- Returns:
- new bindign context
-
index
The index of the parameter in the query.- Parameters:
index
- The index- Returns:
- this context
-
name
The name of the parameter in the query.- Parameters:
name
- The name- Returns:
- this context
-
incomingMethodParameterProperty
@NonNull @NonNull BindingParameter.BindingContext incomingMethodParameterProperty(@Nullable @Nullable PersistentPropertyPath propertyPath) The property that represents incoming method parameter property.- Parameters:
propertyPath
- The property path- Returns:
- this context
-
outgoingQueryParameterProperty
@NonNull @NonNull BindingParameter.BindingContext outgoingQueryParameterProperty(@Nullable @Nullable PersistentPropertyPath propertyPath) The property that represents outgoing query parameter property.- Parameters:
propertyPath
- The property path- Returns:
- this context
-
expandable
Mark the property as expandable.- Returns:
- this context
-
getIndex
int getIndex()The position of the parameter in the query.- Returns:
- The index
-
getName
- Returns:
- The name
-
getIncomingMethodParameterProperty
- Returns:
- The incomingMethodParameterProperty
-
getOutgoingQueryParameterProperty
- Returns:
- The outgoingQueryParameterProperty
-
isExpandable
boolean isExpandable()- Returns:
- Is expandable
-