org.springframework.data.mapping

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

java.lang.Object

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

All Implemented Interfaces:

InstanceCreatorMetadata<P>

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

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

Since:

2.7

Author:

Mark Paluch

Constructor Summary

Constructors

Constructor and Description
FactoryMethod(Method factoryMethod, Parameter<Object,P>... parameters) Creates a new FactoryMethod from the given Constructor and Parameters.

Method Summary

Modifier and Type	Method and Description
Method	getFactoryMethod() Returns the underlying Constructor.
List<Parameter<Object,P>>	getParameters() Returns the Parameters of the executable.
boolean	isCreatorParameter(PersistentProperty<?> property) Returns whether the given PersistentProperty is referenced in a creator argument of the PersistentEntity backing this InstanceCreatorMetadataSupport.
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, isParentParameter

Constructor Detail

FactoryMethod

@SafeVarargs
public FactoryMethod(Method factoryMethod,
                                  Parameter<Object,P>... parameters)

Creates a new FactoryMethod from the given Constructor and Parameters.

Parameters:

factoryMethod - must not be null.

parameters - must not be null.

Method Detail

getFactoryMethod

public Method getFactoryMethod()

Returns the underlying Constructor.

Returns:

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