PersistentEntity (Spring Data Core 2.0.0.M2 API)

All Known Subinterfaces:

MutablePersistentEntity<T,P>

All Known Implementing Classes:

BasicPersistentEntity
```
public interface PersistentEntity<T,P extends PersistentProperty>
```
Represents a persistent entity.

Author:

Oliver Gierke, Graeme Rocher, Jon Brisbin, Patryk Wasik

Property Summary

All Methods Instance Methods Abstract Methods
Type	Property and Description
`boolean`	`hasId` Returns whether the `PersistentEntity` has an id property.
`boolean`	`hasVersion` Returns whether the `PersistentEntity` has a version property.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`doWithAssociations(AssociationHandler<P> handler)` Applies the given `AssociationHandler` to all `Association` contained in this `PersistentEntity`.
`void`	`doWithAssociations(SimpleAssociationHandler handler)`
`void`	`doWithProperties(PropertyHandler<P> handler)` Applies the given `PropertyHandler` to all `PersistentProperty`s contained in this `PersistentEntity`.
`void`	`doWithProperties(SimplePropertyHandler handler)`
`<A extends Annotation> Optional<A>`	`findAnnotation(Class<A> annotationType)` Looks up the annotation of the given type on the `PersistentEntity`.
`Stream<Association<P>>`	`getAssociations()`
`IdentifierAccessor`	`getIdentifierAccessor(Object bean)` Returns the `IdentifierAccessor` for the given bean.
`Optional<P>`	`getIdProperty()` Returns the id property of the `PersistentEntity`.
`String`	`getName()` The entity name including any package prefix.
`Optional<PreferredConstructor<T,P>>`	`getPersistenceConstructor()` Returns the `PreferredConstructor` to be used to instantiate objects of this `PersistentEntity`.
`Stream<P>`	`getPersistentProperties()`
`Optional<P>`	`getPersistentProperty(Class<? extends Annotation> annotationType)` Returns the property equipped with an annotation of the given type.
`Optional<P>`	`getPersistentProperty(String name)` Obtains a `PersistentProperty` instance by name.
`PersistentPropertyAccessor`	`getPropertyAccessor(Object bean)` Returns a `PersistentPropertyAccessor` to access property values of the given bean.
`default P`	`getRequiredIdProperty()`
`default P`	`getRequiredPersistentProperty(String name)` Returns the `PersistentProperty` with the given name.
`Class<T>`	`getType()` Returns the resolved Java type of this entity.
`Alias`	`getTypeAlias()` Returns the alias to be used when storing type information.
`TypeInformation<T>`	`getTypeInformation()` Returns the `TypeInformation` backing this `PersistentEntity`.
`Optional<P>`	`getVersionProperty()` Returns the version property of the `PersistentEntity`.
`boolean`	`hasIdProperty()` Returns whether the `PersistentEntity` has an id property.
`boolean`	`hasVersionProperty()` Returns whether the `PersistentEntity` has a version property.
`boolean`	`isConstructorArgument(PersistentProperty<?> property)` Returns whether the given `PersistentProperty` is referred to by a constructor argument of the `PersistentEntity`.
`boolean`	`isIdProperty(PersistentProperty<?> property)` Returns whether the given `PersistentProperty` is the id property of the entity.
`boolean`	`isVersionProperty(PersistentProperty<?> property)` Returns whether the given `PersistentProperty` is the version property of the entity.

- Property Detail
 - hasId
```
boolean hasIdProperty
```
 Returns whether the PersistentEntity has an id property. If this call returns true, getIdProperty() will return a non-null value.
 - hasVersion
```
boolean hasVersionProperty
```
 Returns whether the PersistentEntity has a version property. If this call returns true, getVersionProperty() will return a non-null value.
- Method Detail
 - getName
```
String getName()
```
 The entity name including any package prefix.
 
 Returns:
 
 must never return null
 - getPersistenceConstructor
```
Optional<PreferredConstructor<T,P>> getPersistenceConstructor()
```
 Returns the PreferredConstructor to be used to instantiate objects of this PersistentEntity.
 
 Returns:
 
 An empty Optional in case no suitable constructor for automatic construction can be found. This usually indicates that the instantiation of the object of that persistent entity is done through either a customer EntityInstantiator or handled by custom conversion mechanisms entirely.
 - isConstructorArgument
```
boolean isConstructorArgument(PersistentProperty<?> property)
```
 Returns whether the given PersistentProperty is referred to by a constructor argument of the PersistentEntity.
 
 Parameters:
 
 property -
 
 Returns:
 
 true if the given PersistentProperty is referred to by a constructor argument or false if not or null.
 - isIdProperty
```
boolean isIdProperty(PersistentProperty<?> property)
```
 Returns whether the given PersistentProperty is the id property of the entity.
 
 Parameters:
 
 property -
 
 Returns:
 - isVersionProperty
```
boolean isVersionProperty(PersistentProperty<?> property)
```
 Returns whether the given PersistentProperty is the version property of the entity.
 
 Parameters:
 
 property -
 
 Returns:
 - getIdProperty
```
Optional getIdProperty()
```
 Returns the id property of the PersistentEntity. Can be null in case this is an entity completely handled by a custom conversion.
 
 Returns:
 
 the id property of the PersistentEntity.
 - getRequiredIdProperty
```
default P getRequiredIdProperty()
```
 - getVersionProperty
```
Optional getVersionProperty()
```
 Returns the version property of the PersistentEntity. Can be null in case no version property is available on the entity.
 
 Returns:
 
 the version property of the PersistentEntity.
 - getPersistentProperty
```
Optional getPersistentProperty(String name)
```
 Obtains a PersistentProperty instance by name.
 
 Parameters:
 
 name - The name of the property
 
 Returns:
 
 the PersistentProperty or Optional#empty() if it doesn't exist.
 - getRequiredPersistentProperty
```
default P getRequiredPersistentProperty(String name)
```
 Returns the PersistentProperty with the given name.
 
 Parameters:
 
 name - the name of the property, must not be null or empty.
 
 Returns:
 
 the PersistentProperty with the given name.
 
 Throws:
 
 IllegalArgumentException - in case no property with the given name exists.
 - getPersistentProperty
```
Optional getPersistentProperty(Class<? extends Annotation> annotationType)
```
 Returns the property equipped with an annotation of the given type.
 
 Parameters:
 
 annotationType - must not be null.
 
 Returns:
 
 Since:
 
 1.8
 - hasIdProperty
```
boolean hasIdProperty()
```
 Returns whether the PersistentEntity has an id property. If this call returns true, getIdProperty() will return a non-null value.
 - hasVersionProperty
```
boolean hasVersionProperty()
```
 Returns whether the PersistentEntity has a version property. If this call returns true, getVersionProperty() will return a non-null value.
 - getType
```
Class<T> getType()
```
 Returns the resolved Java type of this entity.
 
 Returns:
 
 The underlying Java class for this entity
 - getTypeAlias
```
Alias getTypeAlias()
```
 Returns the alias to be used when storing type information. Might be null to indicate that there was no alias defined through the mapping metadata.
 
 Returns:
 - getTypeInformation
```
TypeInformation<T> getTypeInformation()
```
 Returns the TypeInformation backing this PersistentEntity.
 
 Returns:
 - doWithProperties
```
void doWithProperties(PropertyHandler handler)
```
 Applies the given PropertyHandler to all PersistentPropertys contained in this PersistentEntity.
 
 Parameters:
 
 handler - must not be null.
 - doWithProperties
```
void doWithProperties(SimplePropertyHandler handler)
```
 - getPersistentProperties
```
Stream getPersistentProperties()
```
 - doWithAssociations
```
void doWithAssociations(AssociationHandler handler)
```
 Applies the given AssociationHandler to all Association contained in this PersistentEntity.
 
 Parameters:
 
 handler - must not be null.
 - doWithAssociations
```
void doWithAssociations(SimpleAssociationHandler handler)
```
 - getAssociations
```
Stream<Association> getAssociations()
```
 - findAnnotation
```
<A extends Annotation> Optional<A> findAnnotation(Class<A> annotationType)
```
 Looks up the annotation of the given type on the PersistentEntity.
 
 Parameters:
 
 annotationType - must not be null.
 
 Returns:
 
 Since:
 
 1.8
 - getPropertyAccessor
```
PersistentPropertyAccessor getPropertyAccessor(Object bean)
```
 Returns a PersistentPropertyAccessor to access property values of the given bean.
 
 Parameters:
 
 bean - must not be null.
 
 Returns:
 
 Since:
 
 1.10
 - getIdentifierAccessor
```
IdentifierAccessor getIdentifierAccessor(Object bean)
```
 Returns the IdentifierAccessor for the given bean.
 
 Parameters:
 
 bean - must not be null.
 
 Returns:
 
 Since:
 
 1.10

Interface PersistentEntity<T,P extends PersistentProperty<P>>

Property Summary

Method Summary

Property Detail

hasId

hasVersion

Method Detail

getName

getPersistenceConstructor

isConstructorArgument

isIdProperty

isVersionProperty

getIdProperty

getRequiredIdProperty

getVersionProperty

getPersistentProperty

getRequiredPersistentProperty

getPersistentProperty

hasIdProperty

hasVersionProperty

getType

getTypeAlias

getTypeInformation

doWithProperties

doWithProperties

getPersistentProperties

doWithAssociations

doWithAssociations

getAssociations

findAnnotation

getPropertyAccessor

getIdentifierAccessor