Module spring.data.commons

Package org.springframework.data.repository.query

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()	Return the entity type.
abstract List<String>	getInputProperties()	Return the properties required to be used to populate the result.
abstract Class<?>	getReturnedType()	Return the type of the individual objects to return.
abstract Class<?>	getTypeToRead()	Return the type that the query execution is supposed to pass to the underlying infrastructure.
boolean	hasInputProperties()	Return whether the returned type has input properties.
boolean	isDtoProjection()	Return whether the type is a DTO projection.
final boolean	isInstance(Object source)	Return whether the given source object is an instance of the returned type.
boolean	isInterfaceProjection()	Return whether the type is an interface-projection.
abstract boolean	isProjecting()	Return whether the type is projecting, i.e. not of the domain type.
abstract boolean	needsCustomConstruction()	Return 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 java.lang.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()

Return the entity type.

Returns:

isInstance

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

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

Parameters:

source - can be null.

Returns:

getReturnedType

public abstract Class<?> getReturnedType()

Return the type of the individual objects to return.

Returns:

isProjecting

public abstract boolean isProjecting()

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

Returns:

isInterfaceProjection

public boolean isInterfaceProjection()

Return whether the type is an interface-projection.

Since:

3.5.7

isDtoProjection

public boolean isDtoProjection()

Return whether the type is a DTO projection.

Since:

3.5.7

getInputProperties

public abstract List<String> getInputProperties()

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

See Also:

• ProjectionInformation.getInputProperties()

hasInputProperties

public boolean hasInputProperties()

Return whether the returned type has input properties.

Since:

3.3.5

See Also:

• ProjectionInformation.hasInputProperties()

needsCustomConstruction

public abstract boolean needsCustomConstruction()

Return whether the returned type will require custom construction.

getTypeToRead

@Nullable
public abstract Class<?> getTypeToRead()

Return 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.