-
@Retention(value=RUNTIME) @Target(value={FIELD,METHOD}) public @interface XmlAnyElement
Maps a JavaBean property to XML infoset representation and/or JAXB element.This annotation serves as a "catch-all" property while unmarshalling xml content into a instance of a JAXB annotated class. It typically annotates a multi-valued JavaBean property, but it can occur on single value JavaBean property. During unmarshalling, each xml element that does not match a static @XmlElement or @XmlElementRef annotation for the other JavaBean properties on the class, is added to this "catch-all" property.
Usages:
@XmlAnyElement public
Element
[] others; // Collection ofElement
or JAXB elements. @XmlAnyElement(lax="true") publicObject
[] others; @XmlAnyElement private List<Element
> nodes; @XmlAnyElement privateElement
node;Restriction usage constraints
This annotation is mutually exclusive with
XmlElement
,XmlAttribute
,XmlValue
,XmlElements
,XmlID
, andXmlIDREF
.There can be only one
XmlAnyElement
annotated JavaBean property in a class and its super classes.Relationship to other annotations
This annotation can be used with
XmlJavaTypeAdapter
, so that users can map their own data structure to DOM, which in turn can be composed into XML.This annotation can be used with
XmlMixed
like this:// List of java.lang.String or DOM nodes. @XmlAnyElement @XmlMixed List<Object> others;
Schema To Java example
The following schema would produce the following Java class:<xs:complexType name="foo"> <xs:sequence> <xs:element name="a" type="xs:int" /> <xs:element name="b" type="xs:int" /> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType>
class Foo { int a; int b; @
It can unmarshal instances likeXmlAnyElement
List<Element> any; }<foo xmlns:e="extra"> <a>1 <e:other /> // this will be bound to DOM, because unmarshalling is orderless <b>3 <e:other /> <c>5 // this will be bound to DOM, because the annotation doesn't remember namespaces. </foo>
The following schema would produce the following Java class:<xs:complexType name="bar"> <xs:complexContent> <xs:extension base="foo"> <xs:sequence> <xs:element name="c" type="xs:int" /> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:extension> </xs:complexType>
class Bar extends Foo { int c; // Foo.getAny() also represents wildcard content for type definition bar. }
It can unmarshal instances like<bar xmlns:e="extra"> <a>1 <e:other /> // this will be bound to DOM, because unmarshalling is orderless <b>3 <e:other /> <c>5 // this now goes to Bar.c <e:other /> // this will go to Foo.any </bar>
Using XmlAnyElement with XmlElementRef
The
XmlAnyElement
annotation can be used withXmlElementRef
s to designate additional elements that can participate in the content tree.The following schema would produce the following Java class:
<xs:complexType name="foo"> <xs:choice maxOccurs="unbounded" minOccurs="0"> <xs:element name="a" type="xs:int" /> <xs:element name="b" type="xs:int" /> <xs:any namespace="##other" processContents="lax" /> </xs:choice> </xs:complexType>
class Foo { @
It can unmarshal instances likeXmlAnyElement
(lax="true") @XmlElementRefs
({ @XmlElementRef
(name="a", type="JAXBElement.class") @XmlElementRef
(name="b", type="JAXBElement.class") })List
<Object
> others; } @XmlRegistry class ObjectFactory { ... @XmlElementDecl(name = "a", namespace = "", scope = Foo.class)JAXBElement
<Integer> createFooA( Integer i ) { ... } @XmlElementDecl(name = "b", namespace = "", scope = Foo.class)JAXBElement
<Integer> createFooB( Integer i ) { ... }<foo xmlns:e="extra"> <a>1 // this will unmarshal to a
JAXBElement
instance whose value is 1. <e:other /> // this will unmarshal to a DOMElement
. <b>3 // this will unmarshal to aJAXBElement
instance whose value is 1. </foo>W3C XML Schema "lax" wildcard emulation
The lax element of the annotation enables the emulation of the "lax" wildcard semantics. For example, when the Java source code is annotated like this:@
then the following document will unmarshal like this:XmlRootElement
class Foo { @XmlAnyElement(lax=true) publicObject
[] others; }<foo> <unknown /> <foo /> </foo> Foo foo = unmarshal(); // 1 for 'unknown', another for 'foo' assert foo.others.length==2; // 'unknown' unmarshals to a DOM element assert foo.others[0] instanceof Element; // because of lax=true, the 'foo' element eagerly // unmarshals to a Foo object. assert foo.others[1] instanceof Foo;
- Since:
- JAXB2.0
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description boolean
lax
Controls the unmarshaller behavior when it sees elements known to the currentJAXBContext
.Class<? extends DomHandler>
value
Specifies theDomHandler
which is responsible for actually converting XML from/to a DOM-like data structure.
-
-
-
Element Detail
-
lax
public abstract boolean lax
Controls the unmarshaller behavior when it sees elements known to the currentJAXBContext
.When false
If false, all the elements that match the property will be unmarshalled to DOM, and the property will only contain DOM elements.
When true
If true, when an element matches a property marked with
XmlAnyElement
is known toJAXBContext
(for example, there's a class withXmlRootElement
that has the same tag name, or there'sXmlElementDecl
that has the same tag name), the unmarshaller will eagerly unmarshal this element to the JAXB object, instead of unmarshalling it to DOM. Additionally, if the element is unknown but it has a known xsi:type, the unmarshaller eagerly unmarshals the element to aJAXBElement
, with the unknown element name and the JAXBElement value is set to an instance of the JAXB mapping of the known xsi:type.As a result, after the unmarshalling, the property can become heterogeneous; it can have both DOM nodes and some JAXB objects at the same time.
This can be used to emulate the "lax" wildcard semantics of the W3C XML Schema.
- Default:
- false
-
value
public abstract Class<? extends DomHandler> value
Specifies theDomHandler
which is responsible for actually converting XML from/to a DOM-like data structure.- Default:
- javax.xml.bind.annotation.W3CDomHandler.class
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 05:00:12 Cette version de la page est en cache (à la date du 05/11/2024 05:00:12) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/bind/annotation/XmlAnyElement.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.