org.springframework.data.mapping

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

java.lang.Object

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

All Implemented Interfaces:

InstanceCreatorMetadata<P>

public final class PreferredConstructor<T,P extends PersistentProperty<P>>
extends Object

Value object to encapsulate the constructor to be used when mapping persistent data to objects.

Author:

Oliver Gierke, Jon Brisbin, Thomas Darimont, Christoph Strobl, Mark Paluch, Myeonghyeon Lee, Xeno Amess

Constructor Summary

Constructors

Constructor and Description
PreferredConstructor(Constructor<T> constructor, Parameter<Object,P>... parameters) Creates a new PreferredConstructor from the given Constructor and Parameters.

Method Summary

Modifier and Type	Method and Description
Constructor<T>	getConstructor() Returns the underlying Constructor.
List<Parameter<Object,P>>	getParameters() Returns the Parameters of the executable.
boolean	isConstructorParameter(PersistentProperty<?> property) Deprecated. since 3.0, use isCreatorParameter(PersistentProperty) instead.
boolean	isCreatorParameter(PersistentProperty<?> property) Returns whether the given PersistentProperty is referenced in a creator argument of the PersistentEntity backing this InstanceCreatorMetadataSupport.
boolean	isEnclosingClassParameter(Parameter<?,P> parameter) Returns whether the given Parameter is one referring to an enclosing class.
boolean	isExplicitlyAnnotated() Returns whether the constructor was explicitly selected (by PersistenceConstructor).
boolean	isNoArgConstructor() Returns whether the constructor does not have any arguments.
boolean	isParentParameter(Parameter<?,P> parameter) Returns whether the given Parameter is one referring to parent value (such as an enclosing class or a receiver parameter).
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mapping.InstanceCreatorMetadata

getParameterCount, hasParameters

Constructor Detail

PreferredConstructor

@SafeVarargs
public PreferredConstructor(Constructor<T> constructor,
                                         Parameter<Object,P>... parameters)

Creates a new PreferredConstructor from the given Constructor and Parameters.

Parameters:

constructor - must not be null.

parameters - must not be null.

Method Detail

getConstructor

public Constructor<T> getConstructor()

Returns the underlying Constructor.

Returns:

isNoArgConstructor

public boolean isNoArgConstructor()

Returns whether the constructor does not have any arguments.

Returns:

See Also:

InstanceCreatorMetadata.hasParameters()

isExplicitlyAnnotated

public boolean isExplicitlyAnnotated()

Returns whether the constructor was explicitly selected (by PersistenceConstructor).

Returns:

isConstructorParameter

@Deprecated
public boolean isConstructorParameter(PersistentProperty<?> property)

Deprecated. since 3.0, use isCreatorParameter(PersistentProperty) instead.

Parameters:

property -

Returns:

isParentParameter

public boolean isParentParameter(Parameter<?,P> parameter)

Description copied from interface: InstanceCreatorMetadata

Returns whether the given Parameter is one referring to parent value (such as an enclosing class or a receiver parameter).

Returns:

isEnclosingClassParameter

public boolean isEnclosingClassParameter(Parameter<?,P> parameter)

Returns whether the given Parameter is one referring to an enclosing class. That is in case the class this PreferredConstructor belongs to is a member class actually. If that's the case the compiler creates a first constructor argument of the enclosing class type.

Parameters:

parameter - must not be null.

Returns:

true if the PersistentProperty maps to the enclosing class.

getParameters

public List<Parameter<Object,P>> getParameters()

Returns the Parameters of the executable.

Specified by:

getParameters in interface InstanceCreatorMetadata<P extends PersistentProperty<P>>

Returns:

isCreatorParameter

public boolean isCreatorParameter(PersistentProperty<?> property)

Returns whether the given PersistentProperty is referenced in a creator argument of the PersistentEntity backing this InstanceCreatorMetadataSupport.

Results of this call are cached and reused on the next invocation. Calling this method for a PersistentProperty that was not yet added to its owning PersistentEntity will capture that state and return the same result after adding PersistentProperty to its entity.

Specified by:

isCreatorParameter in interface InstanceCreatorMetadata<P extends PersistentProperty<P>>

Parameters:

property - must not be null.

Returns:

true if the PersistentProperty is used in the creator.

toString

public String toString()

Overrides:

toString in class Object