Uses of Interface
org.springframework.data.mapping.PersistentProperty
Package
Description
General purpose conversion framework to read objects from a data store abstraction and write it back.
Base package for the mapping subsystem.
Mapping context API and implementation base classes.
Core implementation of the mapping subsystem's model.
Base classes to implement repositories for various data stores.
-
Uses of PersistentProperty in org.springframework.data.convert
Modifier and TypeInterfaceDescriptioninterface
EntityConverter<E extends PersistentEntity<?,
P>, P extends PersistentProperty<P>, T, S> CombinedEntityReader
andEntityWriter
and add the ability to access aMappingContext
andConversionService
.interface
PropertyValueConverter<DV,
SV, C extends ValueConversionContext<? extends PersistentProperty<?>>> PropertyValueConverter
provides a symmetric way of converting certain properties from domain to store-specific values.static class
PropertyValueConverter.FunctionPropertyValueConverter<DV,
SV, P extends PersistentProperty<P>> APropertyValueConverter
that delegates conversion to the givenBiFunction
s.class
PropertyValueConverterRegistrar<P extends PersistentProperty<P>>
Configuration class to register aPropertyValueConverter
with aSimplePropertyValueConverterRegistry
that can be used withPropertyValueConversions
.static class
PropertyValueConverterRegistrar.ReadingConverterRegistrationBuilder<T,
S, R, P extends PersistentProperty<P>> A helper to build a fluent API to register how to read a database value into a domain object property.static class
PropertyValueConverterRegistrar.WritingConverterRegistrationBuilder<T,
S, P extends PersistentProperty<P>> Helper to build up a fluent registration API starting onclass
SimplePropertyValueConverterRegistry<P extends PersistentProperty<P>>
A registry of property specificvalue convertes
that may be used to convert only specific properties/values of an object.interface
ValueConversionContext<P extends PersistentProperty<P>>
TheValueConversionContext
provides access to the store-specificPersistentProperty
and allows to call the store-default conversion through the read/write methods.interface
ValueConverterRegistry<P extends PersistentProperty<P>>
A registry of property-specificvalue converters
to convert only specific properties/values of an object.Modifier and TypeMethodDescription<DV,
SV, C extends PersistentProperty<C>, VCC extends ValueConversionContext<C>>
PropertyValueConverter<DV,SV, VCC> CustomConversions.getPropertyValueConverter
(C property) Delegate to obtain thePropertyValueConverter
for the given property fromPropertyValueConversions
.<DV,
SV, C extends PersistentProperty<C>, VCC extends ValueConversionContext<C>>
PropertyValueConverter<DV,SV, VCC> PropertyValueConversions.getValueConverter
(C property) Get thePropertyValueConverter
for the given property.<DV,
SV, C extends PersistentProperty<C>, D extends ValueConversionContext<C>>
PropertyValueConverter<DV,SV, D> SimplePropertyValueConversions.getValueConverter
(C property) static <P extends PersistentProperty<P>>
PropertyValueConversionsPropertyValueConversions.simple
(Consumer<PropertyValueConverterRegistrar<P>> config) Helper that allows to createPropertyValueConversions
instance with the configuredconverters
provided via the given callback.static <T extends PersistentProperty<T>>
ValueConverterRegistry<T>ValueConverterRegistry.simple()
Obtain a simpleValueConverterRegistry
.Modifier and TypeMethodDescriptiondefault <DV,
SV, C extends ValueConversionContext<?>>
PropertyValueConverter<DV,SV, C> PropertyValueConverterFactory.getConverter
(PersistentProperty<?> property) Get thePropertyValueConverter
applicable for the givenPersistentProperty
.boolean
CustomConversions.hasPropertyValueConverter
(PersistentProperty<?> property) Delegate check if aPropertyValueConverter
for the given property is present viaPropertyValueConversions
.boolean
PropertyValueConversions.hasValueConverter
(PersistentProperty<?> property) Check if aPropertyValueConverter
is present for the given property.boolean
SimplePropertyValueConversions.hasValueConverter
(PersistentProperty<?> property) ModifierConstructorDescriptionDtoInstantiatingConverter
(Class<?> dtoType, MappingContext<? extends PersistentEntity<?, ?>, ? extends PersistentProperty<?>> context, EntityInstantiators instantiators) Create a newConverter
to instantiate DTOs. -
Uses of PersistentProperty in org.springframework.data.mapping
Modifier and TypeClassDescriptionclass
Association<P extends PersistentProperty<P>>
Value object to captureAssociation
s.interface
AssociationHandler<P extends PersistentProperty<P>>
Callback interface to implement functionality to be applied to a collection ofAssociation
s.final class
FactoryMethod<T,
P extends PersistentProperty<P>> Value object to encapsulate the factory method to be used when mapping persistent data to objects.interface
InstanceCreatorMetadata<P extends PersistentProperty<P>>
Metadata describing a mechanism to create instances of persistent types.class
Parameter<T,
P extends PersistentProperty<P>> Value object to represent constructor parameters.interface
PersistentEntity<T,
P extends PersistentProperty<P>> Represents a persistent entity.interface
PersistentProperty<P extends PersistentProperty<P>>
interface
PersistentPropertyPath<P extends PersistentProperty<P>>
Abstraction of a path ofPersistentProperty
s.interface
PersistentPropertyPaths<T,
P extends PersistentProperty<P>> A wrapper for a collection ofPersistentPropertyPath
s.final class
PreferredConstructor<T,
P extends PersistentProperty<P>> Value object to encapsulate the constructor to be used when mapping persistent data to objects.interface
PropertyHandler<P extends PersistentProperty<P>>
Callback interface to do something with all plainPersistentProperty
instances except associations and transient properties.Modifier and TypeMethodDescriptiondefault Class<? extends PropertyValueConverter<?,
?, ? extends ValueConversionContext<? extends PersistentProperty<?>>>> PersistentProperty.getValueConverterType()
Obtain theconverter type
to be used for reading and writing property values.Modifier and TypeMethodDescriptionvoid
SimplePropertyHandler.doWithPersistentProperty
(PersistentProperty<?> property) Handle the givenPersistentProperty
.PersistentPropertyAccessor.getProperty
(PersistentProperty<?> property) Returns the value of the givenPersistentProperty
of the underlying bean instance.default boolean
PersistentEntity.isConstructorArgument
(PersistentProperty<?> property) Deprecated.boolean
PreferredConstructor.isConstructorParameter
(PersistentProperty<?> property) Deprecated.since 3.0, useInstanceCreatorMetadata.isCreatorParameter(PersistentProperty)
instead.boolean
PersistentEntity.isCreatorArgument
(PersistentProperty<?> property) Returns whether the givenPersistentProperty
is referred to by a creator argument of thePersistentEntity
.boolean
InstanceCreatorMetadata.isCreatorParameter
(PersistentProperty<?> property) Check whether the givenPersistentProperty
is being used as creator parameter.boolean
PersistentEntity.isIdProperty
(PersistentProperty<?> property) Returns whether the givenPersistentProperty
is the id property of the entity.boolean
PersistentEntity.isVersionProperty
(PersistentProperty<?> property) Returns whether the givenPersistentProperty
is the version property of the entity.boolean
AccessOptions.SetOptions.propagate
(PersistentProperty<?> property) Returns whether the given property is supposed to be propagated, i.e. if values for it are supposed to be set at all.AccessOptions.GetOptions.registerCollectionHandler
(PersistentProperty<?> property, Function<? super Collection<?>, Object> handler) Registers aFunction
to handleCollection
values for the given property.TraversalContext.registerCollectionHandler
(PersistentProperty<?> property, Function<? super Collection<?>, Object> handler) Registers aFunction
to handleCollection
values for the given property.AccessOptions.GetOptions.registerHandler
(PersistentProperty<?> property, Class<T> type, Function<? super T, Object> handler) Registers the givenFunction
to post-process values obtained for the givenPersistentProperty
for the given type.AccessOptions.GetOptions.registerHandler
(PersistentProperty<?> property, Function<Object, Object> handler) Registers aFunction
to post-process values for the given property.<T> TraversalContext
TraversalContext.registerHandler
(PersistentProperty<?> property, Class<T> type, Function<? super T, Object> handler) Registers the givenFunction
to post-process values obtained for the givenPersistentProperty
for the given type.TraversalContext.registerHandler
(PersistentProperty<?> property, Function<Object, Object> handler) Registers aFunction
to post-process values for the given property.AccessOptions.GetOptions.registerListHandler
(PersistentProperty<?> property, Function<? super List<?>, Object> handler) TraversalContext.registerListHandler
(PersistentProperty<?> property, Function<? super List<?>, Object> handler) AccessOptions.GetOptions.registerMapHandler
(PersistentProperty<?> property, Function<? super Map<?, ?>, Object> handler) TraversalContext.registerMapHandler
(PersistentProperty<?> property, Function<? super Map<?, ?>, Object> handler) AccessOptions.GetOptions.registerSetHandler
(PersistentProperty<?> property, Function<? super Set<?>, Object> handler) TraversalContext.registerSetHandler
(PersistentProperty<?> property, Function<? super Set<?>, Object> handler) void
PersistentPropertyAccessor.setProperty
(PersistentProperty<?> property, Object value) Sets the givenPersistentProperty
to the given value.Modifier and TypeMethodDescriptionvoid
SimpleAssociationHandler.doWithAssociation
(Association<? extends PersistentProperty<?>> association) Handle the givenAssociation
.default Object
PersistentPropertyAccessor.getProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path) Deprecated.since 2.3, usePersistentPropertyPathAccessor.getProperty(PersistentPropertyPath)
insteaddefault Object
PersistentPropertyAccessor.getProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path, TraversalContext context) Deprecated.default Object
PersistentPropertyPathAccessor.getProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path) Return the value pointed to by the givenPersistentPropertyPath
.PersistentPropertyPathAccessor.getProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path, AccessOptions.GetOptions context) Return the value pointed to by the givenPersistentPropertyPath
.default void
PersistentPropertyAccessor.setProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path, Object value) Deprecated.since 2.3, usePersistentPropertyPathAccessor.setProperty(PersistentPropertyPath, Object)
instead.void
PersistentPropertyPathAccessor.setProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path, Object value) Sets the given value for thePersistentProperty
pointed to by the givenPersistentPropertyPath
.void
PersistentPropertyPathAccessor.setProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path, Object value, AccessOptions.SetOptions options) Sets the given value for thePersistentProperty
pointed to by the givenPersistentPropertyPath
considering the givenAccessOptions
.ModifierConstructorDescriptionGetOptions
(Map<PersistentProperty<?>, Function<Object, Object>> handlers, AccessOptions.GetOptions.GetNulls nullValues) -
Uses of PersistentProperty in org.springframework.data.mapping.context
Modifier and TypeClassDescriptionclass
AbstractMappingContext<E extends MutablePersistentEntity<?,
P>, P extends PersistentProperty<P>> Base class to build mapping metadata and thus create instances ofPersistentEntity
andPersistentProperty
.interface
MappingContext<E extends PersistentEntity<?,
P>, P extends PersistentProperty<P>> This interface defines the overall context including all known PersistentEntity instances and methods to obtain instances on demand. it is used internally to establish associations between entities and also at runtime to obtain entities by name.class
MappingContextEvent<E extends PersistentEntity<?,
P>, P extends PersistentProperty<P>> Base implementation of anApplicationEvent
refering to aPersistentEntity
.Modifier and TypeMethodDescriptionOptional<PersistentEntity<?,
? extends PersistentProperty<?>>> PersistentEntities.getPersistentEntity
(Class<?> type) Returns thePersistentEntity
for the given type.PersistentEntity<?,
? extends PersistentProperty<?>> PersistentEntities.getRequiredPersistentEntity
(Class<?> type) Returns thePersistentEntity
for the given type.Iterator<PersistentEntity<?,
? extends PersistentProperty<?>>> PersistentEntities.iterator()
Modifier and TypeMethodDescriptionPersistentEntity<?,
?> PersistentEntities.getEntityUltimatelyReferredToBy
(PersistentProperty<?> property) Returns thePersistentEntity
the givenPersistentProperty
refers to in case it's an association.PersistentEntities.getTypeUltimatelyReferredToBy
(PersistentProperty<?> property) Returns the type the givenPersistentProperty
ultimately refers to.Modifier and TypeMethodDescription<T> Optional<T>
PersistentEntities.mapOnContext
(Class<?> type, BiFunction<MappingContext<?, ? extends PersistentProperty<?>>, PersistentEntity<?, ?>, T> combiner) Executes the givenBiFunction
on the givenMappingContext
andPersistentEntity
based on the given type.ModifierConstructorDescriptionInvalidPersistentPropertyPath
(String source, TypeInformation<?> type, String unresolvableSegment, PersistentPropertyPath<? extends PersistentProperty<?>> resolvedPath) Creates a newInvalidPersistentPropertyPath
for the given resolved path and message. -
Uses of PersistentProperty in org.springframework.data.mapping.model
Modifier and TypeClassDescriptionclass
AbstractPersistentProperty<P extends PersistentProperty<P>>
Simple implementation ofPersistentProperty
.class
AnnotationBasedPersistentProperty<P extends PersistentProperty<P>>
SpecialPersistentProperty
that takes annotations at a property into account.class
BasicPersistentEntity<T,
P extends PersistentProperty<P>> Simple value object to capture information ofPersistentEntity
s.interface
MutablePersistentEntity<T,
P extends PersistentProperty<P>> Interface capturing mutator methods forPersistentEntity
s.interface
ParameterValueProvider<P extends PersistentProperty<P>>
Callback interface to lookup values for a givenParameter
.class
PersistentEntityParameterValueProvider<P extends PersistentProperty<P>>
ParameterValueProvider
based on aPersistentEntity
to use aPropertyValueProvider
to lookup the value of the property referenced by the givenParameter
.interface
PreferredConstructorDiscoverer<T,
P extends PersistentProperty<P>> Helper class to find aPreferredConstructor
.interface
PropertyValueProvider<P extends PersistentProperty<P>>
SPI for components to provide values for asPersistentProperty
.class
SpELExpressionParameterValueProvider<P extends PersistentProperty<P>>
ParameterValueProvider
that can be used to front aParameterValueProvider
delegate to prefer a SpEL expression evaluation over directly resolving the parameter value with the delegate.Modifier and TypeClassDescriptionclass
AbstractPersistentProperty<P extends PersistentProperty<P>>
Simple implementation ofPersistentProperty
.class
AnnotationBasedPersistentProperty<P extends PersistentProperty<P>>
SpecialPersistentProperty
that takes annotations at a property into account.Modifier and TypeMethodDescription<T,
E extends PersistentEntity<? extends T, P>, P extends PersistentProperty<P>>
TEntityInstantiator.createInstance
(E entity, ParameterValueProvider<P> provider) Creates a new instance of the given entity using the given source to pull data from.static <T,
P extends PersistentProperty<P>>
PreferredConstructor<T,P> Discovers thePreferredConstructor
for the given type.static <T,
P extends PersistentProperty<P>>
PreferredConstructor<T,P> PreferredConstructorDiscoverer.discover
(PersistentEntity<T, P> entity) Discovers thePreferredConstructorDiscoverer
for the givenPersistentEntity
.Modifier and TypeMethodDescriptionClass<? extends PropertyValueConverter<?,
?, ? extends ValueConversionContext<? extends PersistentProperty<?>>>> AnnotationBasedPersistentProperty.getValueConverterType()
Modifier and TypeMethodDescriptionCamelCaseSplittingFieldNamingStrategy.getFieldName
(PersistentProperty<?> property) FieldNamingStrategy.getFieldName
(PersistentProperty<?> property) Returns the field name to be used for the givenPersistentProperty
.PropertyNameFieldNamingStrategy.getFieldName
(PersistentProperty<?> property) <S> S
ConvertingPropertyAccessor.getProperty
(PersistentProperty<?> property, Class<S> targetType) Returns the value of the givenPersistentProperty
converted to the given type.InstantiationAwarePropertyAccessor.getProperty
(PersistentProperty<?> property) protected <S> S
ConvertingPropertyAccessor.getTypedProperty
(PersistentProperty<?> property, Class<S> type) boolean
BasicPersistentEntity.isCreatorArgument
(PersistentProperty<?> property) boolean
BasicPersistentEntity.isIdProperty
(PersistentProperty<?> property) boolean
BasicPersistentEntity.isVersionProperty
(PersistentProperty<?> property) void
ConvertingPropertyAccessor.setProperty
(PersistentProperty<?> property, Object value) void
InstantiationAwarePropertyAccessor.setProperty
(PersistentProperty<?> property, Object value) Modifier and TypeMethodDescriptionvoid
ConvertingPropertyAccessor.setProperty
(PersistentPropertyPath<? extends PersistentProperty<?>> path, Object value) -
Uses of PersistentProperty in org.springframework.data.repository.core.support
ModifierConstructorDescriptionPersistentEntityInformation
(PersistentEntity<T, ? extends PersistentProperty<?>> persistentEntity)
PersistentEntity.isCreatorArgument(PersistentProperty)
instead.