EclipseLink Core 4.0.2 · org.eclipse.persistence.annotations

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	AdditionalCriteria An additional criteria can be specified at the Entity or MappedSuperclass level.
public @interface	Array Array types are extended object-relational data-types supported by some databases.
public @interface	BasicCollection Deprecated A BasicCollection is used to map an org.eclipse.persistence.mappings.DirectCollectionMapping, which stores a collection of simple types (String, Number, Date, etc.).
public @interface	BasicMap Deprecated A BasicMap is used to map an org.eclipse.persistence.mappings.DirectMapMapping, which stores a collection of key-value pairs of simple types (String, Number, Date, etc.).
public @interface	BatchFetch A BatchFetch annotation can be used on any relationship mapping, (OneToOne, ManyToOne, OneToMany, ManyToMany, ElementCollection, BasicCollection, BasicMap).
public @interface	Cache The Cache annotation is used to configure the EclipseLink object cache.
public @interface	CacheIndex Allow a cache index to be define.
public @interface	CacheIndexes Allow a set of cache indexes to be define on an Entity.
public @interface	CacheInterceptor A CacheInterceptor can be set on an Entity and allows all EclipseLink cache access to be intercepted by the developer provided interceptor.
public @interface	CascadeOnDelete Define the foreign key defined by the relationship to cascade the delete on the database.
public @interface	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.
public @interface	ClassExtractor A ClassExtractor allows for a user defined class indicator in place of providing a discriminator column.
public @interface	CloneCopyPolicy A CloneCopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.CloneCopyPolicy on an Entity.
public @interface	CollectionTable Deprecated A CollectionTable annotation is used in conjunction with a BasicCollection or a BasicMap annotation.
public @interface	CompositeMember A CompositeMember annotation is ignored unless is in composite member persistence unit.
public @interface	ConversionValue A ConversionValue annotation is used within an ObjectTypeConverter.
public @interface	Convert The Convert annotation specifies that a named converter should be used with the corresponding mapped attribute.
public @interface	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.
public @interface	Converters A Converters annotation allows the definition of multiple Converter.
public @interface	CopyPolicy A CopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.CopyPolicy on an Entity.
public @interface	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.
public @interface	DeleteAll A DeleteAll annotation is specified to indicate that when an relationship is deleted, it should use a delete all query.
public @interface	DiscriminatorClass A DiscriminatorClass is used within a VariableOneToOne annotation.
public @interface	ExcludeDefaultMappings Specifies default mappings (those that are not explicitly decorated in XML or using annotations)should be omitted.
public @interface	ExistenceChecking The ExistenceChecking annotation is used to specify the type of checking EclipseLink should use when determining if an entity is new or existing.
public @interface	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.
public @interface	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.
public @interface	FetchGroups A FetchGroups annotation allows the definition of multiple FetchGroup.
public @interface	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.
public @interface	Index Allow a database INDEX to be define when generating DDL.
public @interface	Indexes Allow a set of database indexes to be define on an Entity.
public @interface	InstantiationCopyPolicy An InstantiationCopyPolicy is used to set an org.eclipse.persistence.descriptors.copying.InstantiationCopyPolicy on an Entity.
public @interface	JoinFetch A JoinFetch annotation can be used on any relationship mapping, (OneToOne, ManyToOne, OneToMany, ManyToMany, BasicCollection, BasicMap).
public @interface	MapKeyConvert The MapKeyConvert annotation specifies that a named converter should be used with the corresponding mapped attribute key column.
public @interface	Multitenant Multitenant specifies that a given entity is shared amongst multiple tenants of a given application.
public @interface	Mutable A Mutable annotation can be used on a @Basic mapping.
public @interface	NamedStoredFunctionQueries A NamedStoredFunctionQueries annotation allows the definition of multiple NamedStoredFunctionQuery.
public @interface	NamedStoredFunctionQuery A NamedStoredFunctionQuery annotation allows the definition of queries that call stored functions as named queries.
public @interface	NamedStoredProcedureQueries A NamedStoredProcedureQueries annotation allows the definition of multiple NamedStoredProcedureQuery.
public @interface	NamedStoredProcedureQuery A NamedStoredProcedureQuery annotation allows the definition of queries that call stored procedures as named queries.
public @interface	Noncacheable The NonCacheable annotation is used to configure caching behavior for relationships.
public @interface	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.
public @interface	ObjectTypeConverters An ObjectTypeConverters annotation allows the definition of multiple ObjectTypeConverter.
public @interface	OptimisticLocking The OptimisticLocking annotation is used to specify the type of optimistic locking TopLink should use when updating or deleting entities.
public @interface	OrderCorrection OrderCorrection annotation may be specified together with OrderColumn annotation.
public @interface	Partitioned Partitioning is used to partition the data for a class across multiple difference databases or across a database cluster such as Oracle RAC.
public @interface	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.
public @interface	PinnedPartitioning PinnedPartitionPolicy pins requests to a single connection pool.
public @interface	PrimaryKey The PrimaryKey annotation allows advanced configuration of the Id. A validation policy can be given that allows specifying if zero is a valid id value.
public @interface	PrivateOwned A PrivateOwned annotation is used to specify a relationship is privately owned.
public @interface	Properties Annotation for user defined properties.
public @interface	Property Annotation for a user defined property.
public @interface	QueryRedirectors Redirectors allow EclipseLink queries to be intercepted and pre/post processed or redirected.
public @interface	RangePartition Represent a specific range partition.
public @interface	RangePartitioning RangePartitioningPolicy partitions access to a database cluster by a field value from the object, such as the object's id, location, or tenant.
public @interface	ReadOnly The ReadOnly annotation is used to specify that a class is read only.
public @interface	ReadTransformer Annotation for org.eclipse.persistence.mappings.TransformationMapping.
public @interface	ReplicationPartitioning ReplicationPartitioning sends requests to a set of connection pools.
public @interface	ReturnInsert A ReturnInsert annotation allows for INSERT operations to return values back into the object being written.
public @interface	ReturnUpdate A ReturnUpdate annotation allows for UPDATE operations to return values back into the object being written.
public @interface	RoundRobinPartitioning RoundRobinPartitioning sends requests in a round robin fashion to the set of connection pools.
public @interface	SerializedConverter A SerializedConverter is used to serialize an object's value into a database binary, character, or XML field.
public @interface	SerializedConverters A TypeConverters annotation allows the definition of multiple SerializedConverter.
public @interface	SerializedObject SerializedObject annotation is used to set an org.eclipse.persistence.descriptors.SerializedObjectPolicy on an Entity or MappedSuperClass.
public @interface	StoredProcedureParameter A StoredProcedureParameter annotation is used within a NamedStoredProcedureQuery annotation.
public @interface	Struct Struct types are extended object-relational data-types supported by some databases.
public @interface	StructConverter A StructConverter is a special type of converter that handles the conversion of a specific database Struct type.
public @interface	StructConverters A StructConverters annotation allows the definition of multiple StructConverter.
public @interface	Structure Struct types are extended object-relational data-types supported by some databases.
public @interface	TenantDiscriminatorColumn Tenant discriminator column(s) are used with a SINGLE_TABLE multitenant strategy.
public @interface	TenantDiscriminatorColumns A TenantDiscriminatorColumns annotation allows the definition of multiple TenantDiscriminatorColumn.
public @interface	TenantTableDiscriminator A tenant table discriminator is used with a TABLE_PER_TENANT multitenant strategy.
public @interface	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.
public @interface	Transformation Transformation is an optional annotation for org.eclipse.persistence.mappings.TransformationMapping.
public @interface	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.
public @interface	TypeConverters A TypeConverters annotation allows the definition of multiple TypeConverter.
public @interface	UnionPartitioning UnionPartitioning sends queries to all connection pools and unions the results.
public @interface	UuidGenerator Defines a primary key generator that may be referenced by name when a generator element is specified for the `GeneratedValue` annotation.
public @interface	UuidGenerators A UuidGenerators annotation allows the definition of multiple UuidGenerator.
public @interface	ValuePartition Represent a specific value partition.
public @interface	ValuePartitioning ValuePartitioning partitions access to a database cluster by a field value from the object, such as the object's location, or tenant.
public @interface	VariableOneToOne Variable one to one mappings are used to represent a pointer references between a java object and an implementer of an interface.
public @interface	VirtualAccessMethods Specifies that this class contains virtual attributes.
public @interface	WriteTransformer Annotation for org.eclipse.persistence.mappings.TransformationMapping.
public @interface	WriteTransformers An optional annotation for org.eclipse.persistence.mappings.TransformationMapping.

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

Package org.eclipse.persistence.annotations

Annotation Summary

Class Summary

Enum Summary