Class ParameterBinding

java.lang.Object

org.springframework.data.jpa.repository.query.ParameterBinding

Direct Known Subclasses:

ParameterBinding.PartTreeParameterBinding

public class ParameterBinding
extends Object

A generic parameter binding with name or position information.

Author:

Thomas Darimont, Mark Paluch, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParameterBinding.BindingIdentifier	Identifies a binding parameter by name, position or both.
static final record	ParameterBinding.Expression	Value object capturing the expression of which a binding parameter originates.
static final record	ParameterBinding.MethodInvocationArgument	Value object capturing the method invocation parameter reference.
static interface	ParameterBinding.ParameterOrigin	Value type hierarchy to describe where a binding parameter comes from, either method call or an expression.
static class	ParameterBinding.PartTreeParameterBinding	Represents a ParameterBinding in a JPQL query augmented with instructions of how to apply a parameter as an IN parameter.
static final record	ParameterBinding.Synthetic	Value object capturing the expression of which a binding parameter originates.

Method Summary

Modifier and Type	Method	Description
boolean	bindsTo(ParameterBinding other)	Check whether the other binding uses the same bind target.
boolean	equals(Object o)
ParameterBinding.BindingIdentifier	getIdentifier()
@Nullable String	getName()
ParameterBinding.ParameterOrigin	getOrigin()
int	hashCode()
boolean	isCompatibleWith(ParameterBinding other)	Check whether this binding can be bound as the other binding by checking its type and origin.
@Nullable Object	prepare(@Nullable Object valueToBind)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getIdentifier

public ParameterBinding.BindingIdentifier getIdentifier()

getOrigin

public ParameterBinding.ParameterOrigin getOrigin()

getName

public @Nullable String getName()

Returns:

the name if available or null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

prepare

public @Nullable Object prepare(@Nullable Object valueToBind)

Parameters:

valueToBind - value to prepare

bindsTo

public boolean bindsTo(ParameterBinding other)

Check whether the other binding uses the same bind target.

Parameters:

other - must not be null.

Returns:

true if the other binding uses the same parameter to bind to as this one.

isCompatibleWith

public boolean isCompatibleWith(ParameterBinding other)

Check whether this binding can be bound as the other binding by checking its type and origin. Subclasses may override this method to include other properties for the compatibility check.

Parameters:

other -

Returns:

true if the other binding is compatible with this one.