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
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static BindingParameter.BindingContext
create()
Create new context.BindingParameter.BindingContext
expandable()
Mark the property as expandable.PersistentPropertyPath
getIncomingMethodParameterProperty()
int
getIndex()
The position of the parameter in the query.java.lang.String
getName()
PersistentPropertyPath
getOutgoingQueryParameterProperty()
BindingParameter.BindingContext
incomingMethodParameterProperty(PersistentPropertyPath propertyPath)
The property that represents incoming method parameter property.BindingParameter.BindingContext
index(int index)
The index of the parameter in the query.boolean
isExpandable()
BindingParameter.BindingContext
name(java.lang.String name)
The name of the parameter in the query.BindingParameter.BindingContext
outgoingQueryParameterProperty(PersistentPropertyPath propertyPath)
The property that represents outgoing query parameter property.
-
-
-
Method Detail
-
create
static BindingParameter.BindingContext create()
Create new context.- Returns:
- new bindign context
-
index
@NonNull BindingParameter.BindingContext index(int index)
The index of the parameter in the query.- Parameters:
index
- The index- Returns:
- this context
-
name
@NonNull BindingParameter.BindingContext name(@Nullable java.lang.String name)
The name of the parameter in the query.- Parameters:
name
- The name- Returns:
- this context
-
incomingMethodParameterProperty
@NonNull BindingParameter.BindingContext incomingMethodParameterProperty(@Nullable PersistentPropertyPath propertyPath)
The property that represents incoming method parameter property.- Parameters:
propertyPath
- The property path- Returns:
- this context
-
outgoingQueryParameterProperty
@NonNull BindingParameter.BindingContext outgoingQueryParameterProperty(@Nullable PersistentPropertyPath propertyPath)
The property that represents outgoing query parameter property.- Parameters:
propertyPath
- The property path- Returns:
- this context
-
expandable
@NonNull BindingParameter.BindingContext expandable()
Mark the property as expandable.- Returns:
- this context
-
getIndex
int getIndex()
The position of the parameter in the query.- Returns:
- The index
-
getName
@Nullable java.lang.String getName()
- Returns:
- The name
-
getIncomingMethodParameterProperty
@Nullable PersistentPropertyPath getIncomingMethodParameterProperty()
- Returns:
- The incomingMethodParameterProperty
-
getOutgoingQueryParameterProperty
@Nullable PersistentPropertyPath getOutgoingQueryParameterProperty()
- Returns:
- The outgoingQueryParameterProperty
-
isExpandable
boolean isExpandable()
- Returns:
- Is expandable
-
-