Package org.springframework.data.repository.core

Class RepositoryInformationSupport

java.lang.Object

org.springframework.data.repository.core.RepositoryInformationSupport

All Implemented Interfaces:

RepositoryInformation, RepositoryMetadata

public abstract class RepositoryInformationSupport
extends Object
implements RepositoryInformation

Common base class for RepositoryInformation that delays resolution of RepositoryMetadata and the repository base to the latest possible time.

Since:

3.0

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
RepositoryInformationSupport(Supplier<RepositoryMetadata> metadata, Supplier<Class<?>> repositoryBaseClass)

Method Summary

Modifier and Type	Method	Description
Set<Class<?>>	getAlternativeDomainTypes()	Returns the set of types the repository shall be discoverable for when trying to look up a repository by domain type.
CrudMethods	getCrudMethods()	Returns CrudMethods meta information for the repository.
Class<?>	getDomainType()	Returns the raw domain class the repository is declared for.
TypeInformation<?>	getDomainTypeInformation()	Returns the TypeInformationof the domain type the repository is declared to manage.
Class<?>	getIdType()	Returns the raw id class the given class is declared for.
TypeInformation<?>	getIdTypeInformation()	Returns the TypeInformation of the id type of the repository.
Streamable<Method>	getQueryMethods()	Returns all methods considered to be query methods.
Class<?>	getRepositoryBaseClass()	Returns the base class to be used to create the proxy backing instance.
Class<?>	getRepositoryInterface()	Returns the repository interface.
Class<?>	getReturnedDomainClass(Method method)	Returns the domain class returned by the given Method.
TypeInformation<?>	getReturnType(Method method)	Returns the type Method return type as it is declared in the repository.
boolean	hasCustomMethod()	Returns if the configured repository interface has custom methods, that might have to be delegated to a custom implementation.
boolean	isPagingRepository()	Returns whether the repository is a paging one.
protected boolean	isQueryAnnotationPresentOn(Method method)	Checks whether the given method contains a custom store specific query annotation annotated with QueryAnnotation.
boolean	isQueryMethod(Method method)	Returns whether the given method is a query method.
protected boolean	isQueryMethodCandidate(Method method)	Checks whether the given method is a query method candidate.
boolean	isReactiveRepository()	Returns whether the repository is a reactive one, i.e. if it uses reactive types in one of its methods.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.repository.core.RepositoryInformation

getTargetClassMethod, hasQueryMethods, isBaseClassMethod, isCustomMethod

Methods inherited from interface org.springframework.data.repository.core.RepositoryMetadata

getFragments

Constructor Details

RepositoryInformationSupport

public RepositoryInformationSupport(Supplier<RepositoryMetadata> metadata,
 Supplier<Class<?>> repositoryBaseClass)

Method Details

getQueryMethods

public Streamable<Method> getQueryMethods()

Description copied from interface: RepositoryInformation

Returns all methods considered to be query methods.

Specified by:

getQueryMethods in interface RepositoryInformation

Returns:

getIdType

public Class<?> getIdType()

Description copied from interface: RepositoryMetadata

Returns the raw id class the given class is declared for.

Specified by:

getIdType in interface RepositoryMetadata

Returns:

the raw id class of the entity managed by the repository.

getDomainType

public Class<?> getDomainType()

Description copied from interface: RepositoryMetadata

Returns the raw domain class the repository is declared for.

Specified by:

getDomainType in interface RepositoryMetadata

Returns:

the raw domain class the repository is handling.

getRepositoryInterface

public Class<?> getRepositoryInterface()

Description copied from interface: RepositoryMetadata

Returns the repository interface.

Specified by:

getRepositoryInterface in interface RepositoryMetadata

Returns:

getReturnType

public TypeInformation<?> getReturnType(Method method)

Description copied from interface: RepositoryMetadata

Returns the type Method return type as it is declared in the repository. Considers suspended methods and does not unwrap component types but leaves those for further inspection.

Specified by:

getReturnType in interface RepositoryMetadata

Returns:

getReturnedDomainClass

public Class<?> getReturnedDomainClass(Method method)

Description copied from interface: RepositoryMetadata

Returns the domain class returned by the given Method. In contrast to RepositoryMetadata.getReturnType(Method), this method extracts the type from Collections and Page as well.

Specified by:

getReturnedDomainClass in interface RepositoryMetadata

Returns:

See Also:

• RepositoryMetadata.getReturnType(Method)

getCrudMethods

public CrudMethods getCrudMethods()

Description copied from interface: RepositoryMetadata

Returns CrudMethods meta information for the repository.

Specified by:

getCrudMethods in interface RepositoryMetadata

Returns:

isPagingRepository

public boolean isPagingRepository()

Description copied from interface: RepositoryMetadata

Returns whether the repository is a paging one.

Specified by:

isPagingRepository in interface RepositoryMetadata

Returns:

getAlternativeDomainTypes

public Set<Class<?>> getAlternativeDomainTypes()

Description copied from interface: RepositoryMetadata

Returns the set of types the repository shall be discoverable for when trying to look up a repository by domain type.

Specified by:

getAlternativeDomainTypes in interface RepositoryMetadata

Returns:

the set of types the repository shall be discoverable for when trying to look up a repository by domain type, must not be null.

See Also:

• Repositories.getRepositoryFor(Class)

isReactiveRepository

public boolean isReactiveRepository()

Description copied from interface: RepositoryMetadata

Returns whether the repository is a reactive one, i.e. if it uses reactive types in one of its methods.

Specified by:

isReactiveRepository in interface RepositoryMetadata

Returns:

getRepositoryBaseClass

public Class<?> getRepositoryBaseClass()

Description copied from interface: RepositoryInformation

Returns the base class to be used to create the proxy backing instance.

Specified by:

getRepositoryBaseClass in interface RepositoryInformation

Returns:

isQueryMethod

public boolean isQueryMethod(Method method)

Description copied from interface: RepositoryInformation

Returns whether the given method is a query method.

Specified by:

isQueryMethod in interface RepositoryInformation

Returns:

getDomainTypeInformation

public TypeInformation<?> getDomainTypeInformation()

Description copied from interface: RepositoryMetadata

Returns the TypeInformationof the domain type the repository is declared to manage. Will never be null.

Specified by:

getDomainTypeInformation in interface RepositoryMetadata

Returns:

the domain class the repository is handling.

getIdTypeInformation

public TypeInformation<?> getIdTypeInformation()

Description copied from interface: RepositoryMetadata

Returns the TypeInformation of the id type of the repository.

Specified by:

getIdTypeInformation in interface RepositoryMetadata

Returns:

the TypeInformation class of the identifier of the entity managed by the repository. Will never be null.

hasCustomMethod

public boolean hasCustomMethod()

Description copied from interface: RepositoryInformation

Returns if the configured repository interface has custom methods, that might have to be delegated to a custom implementation. This is used to verify repository configuration.

Specified by:

hasCustomMethod in interface RepositoryInformation

Returns:

isQueryAnnotationPresentOn

protected boolean isQueryAnnotationPresentOn(Method method)

Checks whether the given method contains a custom store specific query annotation annotated with QueryAnnotation. The method-hierarchy is also considered in the search for the annotation.

Parameters:

method -

Returns:

isQueryMethodCandidate

protected boolean isQueryMethodCandidate(Method method)

Checks whether the given method is a query method candidate.

Parameters:

method -

Returns: