Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/DesignDocs/317962/Phase1"
< EclipseLink | DesignDocs | 317962
| Line 87: | Line 87: | ||
A property can be configured to be read-only via XML metadata as follows: | A property can be configured to be read-only via XML metadata as follows: | ||
| − | ==== eclipselink-oxm.xml ==== | + | ===== eclipselink-oxm.xml (snippet) ===== |
<source lang="xml"> | <source lang="xml"> | ||
<xml-attribute java-attribute="salary" read-only="true" /> | <xml-attribute java-attribute="salary" read-only="true" /> | ||
| Line 93: | Line 93: | ||
The equivalent configured via annotations would look like: | The equivalent configured via annotations would look like: | ||
| − | ==== org.example.Employee.java ==== | + | ===== org.example.Employee.java ===== |
<source lang="java"> | <source lang="java"> | ||
package org.example; | package org.example; | ||
| Line 104: | Line 104: | ||
</source> | </source> | ||
| − | ==== Proposed XmlReadOnly | + | ===== Proposed XmlReadOnly interface ===== |
<source lang="java"> | <source lang="java"> | ||
package org.eclipse.persistence.oxm.annotations; | package org.eclipse.persistence.oxm.annotations; | ||
Revision as of 11:03, 25 June 2010
Phase 1 - Provide MOXy annotation support equivalent to our XML metadata support
This phase of development involves providing MOXy annotation support equivalent to the existing EclipseLink XML metadata support
Annotations
The following annotations will be targeted in this phase:
| Annotation | XML Metadata Tag | Package | Type | Field | Method |
|---|---|---|---|---|---|
| XmlReadOnly | read-only | X | X | ||
| XmlWriteOnly | write-only | X | X | ||
| XmlCDATA | cdata | X | X | ||
| XmlAccessMethods | xml-access-methods | X | X | ||
| XmlPaths | xml-elements | X | X | ||
| XmlNullPolicy | xml-null-policy | X | X | ||
| XmlIsSetNullPolicy | xml-is-set-null-policy | X | X | ||
| XmlIsSetParameters | n/a | X | X | ||
| XmlIsSetParameter | is-set-parameter | X | X |
Example: XmlReadOnly annotation
The following example will demonstrate how the XmlReadOnly annotation can be applied:
A property can be configured to be read-only via XML metadata as follows:
eclipselink-oxm.xml (snippet)
<xml-attribute java-attribute="salary" read-only="true" />The equivalent configured via annotations would look like:
org.example.Employee.java
package org.example; public class Employee { @javax.xml.bind.annotation.XmlAttribute @org.eclipse.persistence.oxm.annotations.XmlReadOnly public String salary; }
Proposed XmlReadOnly interface
package org.eclipse.persistence.oxm.annotations; @Target({ElementType.FIELD, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) public @interface XmlReadOnly { Boolean value(); }