Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/UserGuide/JPA/Basic JPA Development/Configuration/JPA/Annotations"
| Line 18: | Line 18: | ||
An annotation is a simple, expressive means of decorating Java source code with metadata that is compiled into the corresponding Java class files for interpretation at run time by a JPA persistence provider to manage persistent behavior. | An annotation is a simple, expressive means of decorating Java source code with metadata that is compiled into the corresponding Java class files for interpretation at run time by a JPA persistence provider to manage persistent behavior. | ||
| − | A metadata annotation represents a Java language feature that lets you attach structured and typed metadata to the source code. Annotations alone are sufficient for the metadata specification -- you do not need to use XML. | + | A metadata annotation represents a Java language feature that lets you attach structured and typed metadata to the source code. Annotations alone are sufficient for the metadata specification -- you do not need to use XML. Standard JPA annotations are in the [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/package-summary.html <tt>javax.persistence</tt>] package. EclipseLink annotations are in the [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/package-summary.html <tt>org.eclipse.persistence.annotations</tt>] package. {{EclipseLink_Spec |
|link=http://jcp.org/en/jsr/detail?id=220 | |link=http://jcp.org/en/jsr/detail?id=220 | ||
|section=Chapter 10 "Metadata Annotations" | |section=Chapter 10 "Metadata Annotations" | ||
Revision as of 10:35, 19 April 2011
EclipseLink JPA
| EclipseLink | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| Open • Help Wanted • Bug Day | |
| Contribute | |
| Browse Source |
Key API
Adding Metadata Using Annotations
An annotation is a simple, expressive means of decorating Java source code with metadata that is compiled into the corresponding Java class files for interpretation at run time by a JPA persistence provider to manage persistent behavior.
A metadata annotation represents a Java language feature that lets you attach structured and typed metadata to the source code. Annotations alone are sufficient for the metadata specification -- you do not need to use XML. Standard JPA annotations are in the javax.persistence package. EclipseLink annotations are in the org.eclipse.persistence.annotations package.
For more information, see Chapter 10 "Metadata Annotations" in the JPA Specification.
For more information, see Section 12.2 "XML Overriding Rules" in the JPA Specification.
Using Metadata Annotations
Use annotations to configure the persistent behavior of your entities. For example, to designate a Java class as a JPA entity, use the @Entity annotation as shown in this example:
@Entity public class Employee implements Serializable { ... }
You can apply annotations at the following levels:
- Class
- Method
- Field
EclipseLink defines a set of proprietary annotations to take advantage of EclipseLink-specific features. You can find them in the org.eclipse..persistence.annotations package. These annotations are not available through the use of JPA metadata.
Advantages and Disadvantages of Using Annotations
Using annotations provides several advantages:
- They are relatively simple to use and understand.
- They provide in-line metadata within with the code that it describes; you do not need to replicate the source code context of where the metadata applies.
The primary disadvantage of annotations is that the metatdata becomes unnecessarily coupled to the code; changes to metadata require changing the source code.
