Package org.eclipse.persistence.annotations

Class Summary

Class	Description
TransientCompatibleAnnotations	PUBLIC: This class is used by our JPA annotation processing to discover which annotations may coexist with a javax.persistence.Transient annotation.

Enum Summary

Enum	Description
BatchFetchType	Enum used with the BatchFetch annotation, or "eclipselink.batch.type" query hint.
CacheCoordinationType	An enum that is used within the Cache annotation.
CacheKeyType	Configures what type of Id value is used to store the object in the cache.
CacheType	The CacheType enum is used with the Cache annotation for a persistent class.
ChangeTrackingType	An enum that is used within the ChangeTracking annotation.
DatabaseChangeNotificationType	Configures what type of database change notification an entity/descriptor should use.
Direction	An enum that is used within the StoredProcedureParameter annotation.
ExistenceType	An enum that is used within the ExistenceChecking annotation.
IdValidation	IdValidation configures which id values are considered valid when loading from the database.
JoinFetchType	An enum type that is used within the JoinFetch annotation.
MultitenantType	An enum that is used within the Multitenant annotation.
OptimisticLockingType	An enum that is used within the OptimisticLocking annotation.
OrderCorrectionType	The OrderCorrectionType enum is used with OrderCorrection annotation that could be applied together with OrderColumn annotation.
TenantTableDiscriminatorType	An enum that is used within the TenantTableDiscriminator annotation.

Annotation Types Summary

Annotation Type	Description
AdditionalCriteria	An additional criteria can be specified at the Entity or MappedSuperclass level.
Array	Array types are extended object-relational data-types supported by some databases.
BasicCollection	Deprecated
BasicMap	Deprecated
BatchFetch	A BatchFetch annotation can be used on any relationship mapping, (OneToOne, ManyToOne, OneToMany, ManyToMany, ElementCollection, BasicCollection, BasicMap).
Cache	The Cache annotation is used to configure the EclipseLink object cache.
CacheIndex	Allow a cache index to be define.
CacheIndexes	Allow a set of cache indexes to be define on an Entity.
CacheInterceptor	A CacheInterceptor can be set on an Entity and allows all EclipseLink cache access to be intercepted by the developer provided interceptor.
CascadeOnDelete	Define the foreign key defined by the relationship to cascade the delete on the database.
ChangeTracking	The ChangeTracking annotation is used to specify the org.eclipse.persistence.descriptors.changetracking.ObjectChangePolicy which computes changes sets for EclipseLink's UnitOfWork commit process.
ClassExtractor	A ClassExtractor allows for a user defined class indicator in place of providing a discriminator column.
CloneCopyPolicy	A CloneCopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.CloneCopyPolicy on an Entity.
CollectionTable	Deprecated
CompositeMember	A CompositeMember annotation is ignored unless is in composite member persistence unit.
ConversionValue	A ConversionValue annotation is used within an ObjectTypeConverter.
Convert	The Convert annotation specifies that a named converter should be used with the corresponding mapped attribute.
Converter	A Converter is used to customize the values during the reading from the database into the object model as well as during the writing back of changes into the database.
Converters	A Converters annotation allows the definition of multiple Converter.
CopyPolicy	A CopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.CopyPolicy on an Entity.
Customizer	The Customizer annotation is used to specify a class that implements the org.eclipse.persistence.config.DescriptorCustomizer interface and is to run against an entity's class descriptor after all metadata processing has been completed.
DeleteAll	A DeleteAll annotation is specified to indicate that when an relationship is deleted, it should use a delete all query.
DiscriminatorClass	A DiscriminatorClass is used within a VariableOneToOne annotation.
ExcludeDefaultMappings	Specifies default mappings (those that are not explicitly decorated in XML or using annotations)should be omitted.
ExistenceChecking	The ExistenceChecking annotation is used to specify the type of checking EclipseLink should use when determining if an entity is new or existing.
FetchAttribute	A fetch attribute is specified within a fetch group and is used as a performance enhancement that allows a group of attributes of an object to be loaded on demand, which means that the data for an attribute might not loaded from the underlying data source until an explicit access call for the attribute first occurs.
FetchGroup	A fetch group is a performance enhancement that allows a group of attributes of an object to be loaded on demand, which means that the data for an attribute might not loaded from the underlying data source until an explicit access call for the attribute first occurs.
FetchGroups	A FetchGroups annotation allows the definition of multiple FetchGroup.
HashPartitioning	HashPartitioning partitions access to a database cluster by the hash of a field value from the object, such as the object's location, or tenant.
Index	Allow a database INDEX to be define when generating DDL.
Indexes	Allow a set of database indexes to be define on an Entity.
InstantiationCopyPolicy	An InstantiationCopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.InstantiationCopyPolicy on an Entity.
JoinFetch	A JoinFetch annotation can be used on any relationship mapping, (OneToOne, ManyToOne, OneToMany, ManyToMany, BasicCollection, BasicMap).
MapKeyConvert	The MapKeyConvert annotation specifies that a named converter should be used with the corresponding mapped attribute key column.
Multitenant	Multitenant specifies that a given entity is shared amongst multiple tenants of a given application.
Mutable	A Mutable annotation can be used on a @Basic mapping.
NamedStoredFunctionQueries	A NamedStoredFunctionQueries annotation allows the definition of multiple NamedStoredFunctionQuery.
NamedStoredFunctionQuery	A NamedStoredFunctionQuery annotation allows the definition of queries that call stored functions as named queries.
NamedStoredProcedureQueries	A NamedStoredProcedureQueries annotation allows the definition of multiple NamedStoredProcedureQuery.
NamedStoredProcedureQuery	A NamedStoredProcedureQuery annotation allows the definition of queries that call stored procedures as named queries.
Noncacheable	The NonCacheable annotation is used to configure caching behavior for relationships.
ObjectTypeConverter	The ObjectTypeConverter annotation is used to specify a TopLink org.eclipse.persistence.mappings.converters.ObjectTypeConverter that converts a fixed number of database data value(s) to Java object value(s) during the reading and writing of a mapped attribute An ObjectTypeConverter must be be uniquely identified by name and can be defined at the class, field and property level and can be specified within an Entity, MappedSuperclass and Embeddable class.
ObjectTypeConverters	An ObjectTypeConverters annotation allows the definition of multiple ObjectTypeConverter.
OptimisticLocking	The OptimisticLocking annotation is used to specify the type of optimistic locking TopLink should use when updating or deleting entities.
OrderCorrection	OrderCorrection annotation may be specified together with OrderColumn annotation.
Partitioned	Partitioning is used to partition the data for a class across multiple difference databases or across a database cluster such as Oracle RAC.
Partitioning	A Partitioning is used to partition the data for a class across multiple difference databases or across a database cluster such as Oracle RAC.
PinnedPartitioning	PinnedPartitionPolicy pins requests to a single connection pool.
PrimaryKey	The PrimaryKey annotation allows advanced configuration of the Id.
PrivateOwned	A PrivateOwned annotation is used to specify a relationship is privately owned.
Properties	Annotation for user defined properties.
Property	Annotation for a user defined property.
QueryRedirectors	Redirectors allow EclipseLink queries to be intercepted and pre/post processed or redirected.
RangePartition	Represent a specific range partition.
RangePartitioning	RangePartitioningPolicy partitions access to a database cluster by a field value from the object, such as the object's id, location, or tenant.
ReadOnly	The ReadOnly annotation is used to specify that a class is read only.
ReadTransformer	Annotation for org.eclipse.persistence.mappings.TransformationMapping.
ReplicationPartitioning	ReplicationPartitioning sends requests to a set of connection pools.
ReturnInsert	A ReturnInsert annotation allows for INSERT operations to return values back into the object being written.
ReturnUpdate	A ReturnUpdate annotation allows for UPDATE operations to return values back into the object being written.
RoundRobinPartitioning	RoundRobinPartitioning sends requests in a round robin fashion to the set of connection pools.
SerializedConverter	A SerializedConverter is used to serialize an object's value into a database binary, character, or XML field.
SerializedConverters	A TypeConverters annotation allows the definition of multiple SerializedConverter.
SerializedObject	SerializedObject annotation is used to set an org.eclipse.persistence.descriptors.SerializedObjectPolicy on an Entity or MappedSuperClass.
StoredProcedureParameter	A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery annotation.
Struct	Struct types are extended object-relational data-types supported by some databases.
StructConverter	A StructConverter is a special type of converter that handles the conversion of a specific database Struct type.
StructConverters	A StructConverters annotation allows the definition of multiple StructConverter.
Structure	Struct types are extended object-relational data-types supported by some databases.
TenantDiscriminatorColumn	Tenant discriminator column(s) are used with a SINGLE_TABLE multitenant strategy.
TenantDiscriminatorColumns	A TenantDiscriminatorColumns annotation allows the definition of multiple TenantDiscriminatorColumn.
TenantTableDiscriminator	A tenant table discriminator is used with a TABLE_PER_TENANT multitenant strategy.
TimeOfDay	A TimeOfDay annotation is used to specify a specific time of day using a Calendar instance which is to be used within an OptimisticLocking annotation.
Transformation	Transformation is an optional annotation for org.eclipse.persistence.mappings.TransformationMapping.
TypeConverter	The TypeConverter annotation is used to specify an EclipseLink org.eclipse.persistence.mappings.converters.TypeConversionConverter for modification of the data value(s) during the reading and writing of a mapped attribute.
TypeConverters	A TypeConverters annotation allows the definition of multiple TypeConverter.
UnionPartitioning	UnionPartitioning sends queries to all connection pools and unions the results.
UuidGenerator	Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation.
ValuePartition	Represent a specific value partition.
ValuePartitioning	ValuePartitioning partitions access to a database cluster by a field value from the object, such as the object's location, or tenant.
VariableOneToOne	Variable one to one mappings are used to represent a pointer references between a java object and an implementer of an interface.
VirtualAccessMethods	Specifies that this class contains virtual attributes.
WriteTransformer	Annotation for org.eclipse.persistence.mappings.TransformationMapping.
WriteTransformers	An optional annotation for org.eclipse.persistence.mappings.TransformationMapping.