JAXB élément qui est à la fois facultatif et nillable

TL;DR

Pour

@XmlElementRef(name="foo", required=false)
protected JAXBElement<String> foo;

Une absence de nœud dans le document correspondent à ce champ est null. Un élément XML présents dans le document avec xsi:nil="true" correspondra à la valeur d'une instance de JAXBElement avec une valeur de null.

Vous pouvez également fournir un schéma XML au lieu d'avoir JAXB générer à l'aide de la location de propriété sur l'ensemble des @XmlSchema annotation.

@XmlSchema(
    ...
    location="http://www.example.com/schema/root.xsd")
package forum19665550;

import javax.xml.bind.annotation.XmlSchema;

---

Maréchal/Unmarshal

Java Modèle

Racine

C'est un objet avec les deux champs qui peuvent représenter facultatif et nillable de données.

import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.*;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Root {

    @XmlElementRef(name="foo", required=false)
    protected JAXBElement<String> foo;

    @XmlElementRef(name="bar", required=false)
    protected JAXBElement<String> bar;

}

ObjectFactory

import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.*;
import javax.xml.namespace.QName;

@XmlRegistry
public class ObjectFactory {

    @XmlElementDecl(name="foo")
    public JAXBElement<String> createFoo(String foo) {
        return new JAXBElement<String>(new QName("foo"), String.class, foo);
    }

    @XmlElementDecl(name="bar")
    public JAXBElement<String> createBar(String bar) {
        return new JAXBElement<String>(new QName("bar"), String.class, bar);
    }

}

Le Code De Démonstration

Démo

La démo de code ci-dessous va étudier les différences dans les valeurs de foo et bar. Vous pouvez utiliser le JAXBIntrospector classe pour obtenir la valeur réelle d'une instance de JAXBElement. Il y a un bug dans EclipseLink JAXB (MOXy) liées à unmarshalling une instance de JAXBElement emballage une valeur null (voir: http://bugs.eclipse.org/420746).

import java.io.File;
import javax.xml.bind.*;

public class Demo {

    public static void main(String[] args) throws Exception {
        JAXBContext jc = JAXBContext.newInstance(Root.class, ObjectFactory.class);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        File xml = new File("src/forum19665550/input.xml");
        Root root = (Root) unmarshaller.unmarshal(xml);

        System.out.println("foo was set:          " + (root.foo != null));
        System.out.println("bar was set:          " + (root.bar != null));
        System.out.println("foo value:            " + root.foo);
        System.out.println("bar value:            " + root.bar);
        System.out.println("foo unwrapped value:  " + JAXBIntrospector.getValue(root.foo));
        System.out.println("bar unwrapped value:  " + JAXBIntrospector.getValue(root.bar));

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(root, System.out);
    }

}

d'entrée.xml/Sortie

Dans le résultat, nous voyons que nous pouvons distinguer entre un élément absent du document et d'un élément avec " xsi:nil="true" et ont encore de la valeur nulle.

foo was set:          false
bar was set:          true
foo value:            null
bar value:            javax.xml.bind.JAXBElement@4af42ea0
foo unwrapped value:  null
bar unwrapped value:  null
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
    <bar xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>

Générer un Schéma XML

Le Code De Démonstration

GenerateSchema

Ci-dessous quelques JAXB code qui permettra de générer un Schéma XML à partir du modèle annoté.

import java.io.IOException;
import javax.xml.bind.*;
import javax.xml.transform.Result;
import javax.xml.transform.stream.StreamResult;

public class GenerateSchema {

    public static void main(String[] args) throws Exception {
        JAXBContext jc = JAXBContext.newInstance(Root.class);

        jc.generateSchema(new SchemaOutputResolver() {

            @Override
            public Result createOutput(String namespaceUri,
                    String suggestedFileName) throws IOException {
                StreamResult result = new StreamResult(System.out);
                result.setSystemId(suggestedFileName);
                return result;
            }

        });
    }

}

Sortie

Ici est celle du Schéma XML. Vous avez raison qu'il n'indique pas que le foo et bar éléments sont nillable.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="bar" type="xs:string"/>

  <xs:element name="foo" type="xs:string"/>

  <xs:element name="root" type="root"/>

  <xs:complexType name="root">
    <xs:sequence>
      <xs:element ref="foo" minOccurs="0"/>
      <xs:element ref="bar" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

---

Fournir un Schéma XML

Au lieu d'avoir JAXB tirer un Schéma XML à partir de votre modèle, vous pouvez pointer vers votre existant qui contiennent plus d'information.

paquet-info

C'est fait en spécifiant le location de propriété sur l'ensemble des @XmlSchema annotation.

@XmlSchema(
    ...
    location="http://www.example.com/schema/root.xsd")
package forum19665550;

import javax.xml.bind.annotation.XmlSchema;

OriginalL'auteur Blaise Doughan

Vous pouvez personnaliser la liaison par

<jaxb:globalBindings generateElementProperty="false" />

Comme documenté dans Personnalisé De Liaison , pour exactement le même cas que vous posez sur.

Je suis à l'aide personnalisée de liaison avec le plugin maven org.jvnet.jaxb2.maven2:maven-jaxb2-plugin

OriginalL'auteur M-Zaiady