EclipseLink Core 4.0.2 · org.eclipse.persistence.oxm.annotations

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	XmlAccessMethods Purpose:This annotation allows the userTo specify accessor methods for a given property.
public @interface	XmlCDATA Wrap the value inside a CDATA section.
public @interface	XmlClassExtractor A ClassExtractor allows for a user defined class indicator in place of using xsi:type.
public @interface	XmlCustomizer The XmlCustomizer annotation is used to specify a class that implements the org.eclipse.persistence.config.DescriptorCustomizer interface and is to run against a class descriptor after all metadata processing has been completed.
public @interface	XmlDiscriminatorNode The XmlDiscriminatorNode annotation is used to specify the class indicator field name when using inheritance.
public @interface	XmlDiscriminatorValue The XmlDiscriminatorValue annotation is used to specify the class indicator for a given type when using inheritance.
public @interface	XmlElementNillable Purpose: Provide a means of setting nillable on type and package level, which is not possible with standard XmlElement annotation.
public @interface	XmlElementsJoinNodes XmlElementsJoinNodes is used in conjunction with `XmlElements` in order to specify the key references for the targets of the XmlElements annotation.
public @interface	XmlIDExtension Purpose: Provide a way to allow properties with XmlID annotation have different type than java.lang.String.
public @interface	XmlInverseReference This annotation is used to map a back-pointer during the unmarshal operation.
public @interface	XmlIsSetNullPolicy Purpose: Provide a means of using annotations to customise the handling of null values and their xml representation.
public @interface	XmlJoinNode XmlJoinNode is used in conjunction with `XmlKey` to specify a reference mapping.
public @interface	XmlJoinNodes XmlJoinNodes is a holder for multiple `XmlJoinNode` annotations.
public @interface	XmlKey XmlKey is used to mark a property as a key, to be referenced using a key-based mapping via `XmlJoinNode`.
public @interface	XmlLocation XmlLocation can be used on a property of type Locator, to provide information about the XML location (line and column number, source location) that the owning object was unmarshalled from.
public @interface	XmlNamedAttributeNode A `XmlNamedAttributeNode` is a member element of a `XmlNamedObjectGraph`.
public @interface	XmlNamedObjectGraph Purpose: Used to define the boundaries for a marshal or unmarhsal operation.
public @interface	XmlNamedObjectGraphs Used to group `XmlNamedObjectGraph` annotations.
public @interface	XmlNamedSubgraph A `XmlNamedSubgraph` is a member element of a `XmlNamedObjectGraph`.
public @interface	XmlNameTransformer An XmlNameTransformer allows for a user defined class to transform names.
public @interface	XmlNullPolicy Purpose: Provide a means of using annotations to customise the handling of null values and their xml representation.
public @interface	XmlParameter Purpose: An annotation representing a parameter to a method.
public @interface	XmlPath XPath based mapping is what allows an existing object model to be mapped to an existing XML schema.
public @interface	XmlPaths Purpose: This annotation is used in conjunction with an XmlElements annotation to specify an XmlPath for each of the XmlElement annotations in the XmlElements.
public @interface	XmlProperties Annotation for user defined properties.
public @interface	XmlProperty Annotation for a user defined property.
public @interface	XmlReadOnly Purpose: This annotation indicates that a specific property should be flagged as read-only by EclipseLink.
public @interface	XmlReadTransformer Purpose: XmlReadTransformer is used to allow the user direct access to the XML in order to populate their object model.
public @interface	XmlTransformation Transformation is an optional annotation for org.eclipse.persistence.mappings.oxm.XMLTransformationMapping.
public @interface	XmlValueExtension Purpose: Provide a way to allow classes, which contain property annotated with XmlValue to extend classes other than java.lang.Object.
public @interface	XmlVariableNode
public @interface	XmlVirtualAccessMethods The XmlVirtualAccessMethods annotation is used to indicate that this class has been configured to hold virtual properties.
public @interface	XmlWriteOnly Purpose: This annotation indicates that a specific property should be flagged as write-only by EclipseLink.
public @interface	XmlWriteTransformer Annotation for org.eclipse.persistence.mappings.oxm.XMLTransformationMapping.
public @interface	XmlWriteTransformers Purpose: Annotation used to wrap multiple XmlWriteTransformer annotations.

Modifier and Type	Enum and Description
public enum	XmlMarshalNullRepresentation Purpose: This enumeration provides a means of specifying how a null value in a java object should be marshalled to XML.
public enum	XmlVirtualAccessMethodsSchema

Package org.eclipse.persistence.oxm.annotations

Annotation Summary

Enum Summary