Package org.springframework.data.mapping

Class Parameter<T,P extends PersistentProperty<P>>

java.lang.Object

org.springframework.data.mapping.Parameter<T,P>

Type Parameters:

T - the type of the parameter

public class Parameter<T,P extends PersistentProperty<P>>
extends Object

Value object to represent constructor parameters.

Author:

Oliver Gierke, Christoph Strobl, Chris Bono

Constructor Summary

Constructors

Constructor	Description
Parameter(String name, TypeInformation<T> type, Annotation[] annotations, PersistentEntity<T,P> entity)	Creates a new Parameter with the given name, TypeInformation as well as an array of Annotations.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
MergedAnnotations	getAnnotations()	Merged annotations that this parameter is annotated with.
String	getName()	Returns the name of the parameter (through constructor/method parameter naming).
Class<T>	getRawType()	Returns the raw resolved type of the parameter.
String	getRequiredName()	Returns the required name of the parameter (through constructor/method parameter naming) or throws IllegalStateException if the parameter has no name.
String	getRequiredValueExpression()	Returns the required expression to be used when looking up a source data structure to populate the actual parameter value or throws IllegalStateException if there's no expression.
String	getSpelExpression()	Deprecated. since 3.3, use getValueExpression() instead.
TypeInformation<T>	getType()	Returns the TypeInformation of the parameter.
String	getValueExpression()	Returns the expression to be used when looking up a source data structure to populate the actual parameter value.
int	hashCode()
boolean	hasName()	Returns whether the parameter has a name.
boolean	hasSpelExpression()	Deprecated. since 3.3, use hasValueExpression() instead.
boolean	hasValueExpression()	Returns whether the constructor parameter is equipped with a value expression.

Methods inherited from class java.lang.Object

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

Constructor Details

Parameter

public Parameter(@Nullable
 String name,
 TypeInformation<T> type,
 Annotation[] annotations,
 @Nullable
 PersistentEntity<T,P> entity)

Creates a new Parameter with the given name, TypeInformation as well as an array of Annotations. Will inspect the annotations for an Value annotation to lookup a key or an SpEL expression to be evaluated.

Parameters:

name - the name of the parameter, can be null

type - must not be null

annotations - must not be null but can be empty

entity - must not be null.

Method Details

getName

@Nullable
public String getName()

Returns the name of the parameter (through constructor/method parameter naming).

Returns:

the name of the parameter.

See Also:

• ParameterNameDiscoverer

hasName

public boolean hasName()

Returns whether the parameter has a name.

Returns:

whether the parameter has a name.

Since:

3.5

getRequiredName

public String getRequiredName()

Returns the required name of the parameter (through constructor/method parameter naming) or throws IllegalStateException if the parameter has no name.

Returns:

the parameter name or throws IllegalStateException if the parameter does not have a name.

Since:

3.5

See Also:

• ParameterNameDiscoverer

getType

public TypeInformation<T> getType()

Returns the TypeInformation of the parameter.

Returns:

getAnnotations

public MergedAnnotations getAnnotations()

Merged annotations that this parameter is annotated with.

Returns:

Since:

2.5

getRawType

public Class<T> getRawType()

Returns the raw resolved type of the parameter.

Returns:

getSpelExpression

@Nullable
public String getSpelExpression()

Deprecated.

since 3.3, use getValueExpression() instead.

Returns the expression to be used when looking up a source data structure to populate the actual parameter value.

Returns:

the expression to be used when looking up a source data structure.

getValueExpression

@Nullable
public String getValueExpression()

Returns the expression to be used when looking up a source data structure to populate the actual parameter value.

Returns:

the expression to be used when looking up a source data structure.

Since:

3.3

getRequiredValueExpression

public String getRequiredValueExpression()

Returns the required expression to be used when looking up a source data structure to populate the actual parameter value or throws IllegalStateException if there's no expression.

Returns:

the expression to be used when looking up a source data structure.

Since:

3.3

hasSpelExpression

@Deprecated(since="3.3")
public boolean hasSpelExpression()

Deprecated.

since 3.3, use hasValueExpression() instead.

Returns whether the constructor parameter is equipped with a SpEL expression.

Returns:

true} if the parameter is equipped with a SpEL expression.

hasValueExpression

public boolean hasValueExpression()

Returns whether the constructor parameter is equipped with a value expression.

Returns:

true} if the parameter is equipped with a value expression.

Since:

3.3

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object