Class ReturnedType

java.lang.Object

org.springframework.data.repository.query.ReturnedType

public abstract class ReturnedType
extends Object

A representation of the type returned by a QueryMethod.

Since:

1.12

Author:

Oliver Gierke, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReturnedType(Class<?> domainType)

Method Summary

Modifier and Type	Method	Description
final Class<?>	getDomainType()	Returns the entity type.
abstract List<String>	getInputProperties()	Returns the properties required to be used to populate the result.
abstract Class<?>	getReturnedType()	Returns the type of the individual objects to return.
abstract @Nullable Class<?>	getTypeToRead()	Returns the type that the query execution is supposed to pass to the underlying infrastructure.
boolean	hasInputProperties()	Returns whether the returned type has input properties.
final boolean	isInstance(@Nullable Object source)	Returns whether the given source object is an instance of the returned type.
abstract boolean	isProjecting()	Returns whether the type is projecting, i.e. not of the domain type.
abstract boolean	needsCustomConstruction()	Returns whether the returned type will require custom construction.
static ReturnedType	of(Class<?> returnedType, Class<?> domainType, ProjectionFactory factory)	Creates a new ReturnedType for the given returned type, domain type and ProjectionFactory.

Methods inherited from class Object

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

Constructor Details

ReturnedType

protected ReturnedType(Class<?> domainType)

Method Details

of

public static ReturnedType of(Class<?> returnedType,
 Class<?> domainType,
 ProjectionFactory factory)

Creates a new ReturnedType for the given returned type, domain type and ProjectionFactory.

Parameters:

returnedType - return type for the query result, must not be null.

domainType - domain type for the query context, must not be null.

factory - must not be null.

Returns:

the ReturnedType for the given returned type, domain type and ProjectionFactory.

Since:

3.3.5

getDomainType

public final Class<?> getDomainType()

Returns the entity type.

Returns:

isInstance

@Contract("null -> false")
public final boolean isInstance(@Nullable Object source)

Returns whether the given source object is an instance of the returned type.

Parameters:

source - can be null.

Returns:

isProjecting

public abstract boolean isProjecting()

Returns whether the type is projecting, i.e. not of the domain type.

Returns:

getReturnedType

public abstract Class<?> getReturnedType()

Returns the type of the individual objects to return.

Returns:

needsCustomConstruction

public abstract boolean needsCustomConstruction()

Returns whether the returned type will require custom construction.

Returns:

getTypeToRead

public abstract @Nullable Class<?> getTypeToRead()

Returns the type that the query execution is supposed to pass to the underlying infrastructure. null is returned to indicate a generic type (a map or tuple-like type) shall be used.

Returns:

getInputProperties

public abstract List<String> getInputProperties()

Returns the properties required to be used to populate the result.

Returns:

See Also:

• ProjectionInformation.getInputProperties()

hasInputProperties

public boolean hasInputProperties()

Returns whether the returned type has input properties.

Returns:

Since:

3.3.5

See Also:

• ProjectionInformation.hasInputProperties()