javax.xml.bind.Binder.getXMLNode() Method

---

---

Description

The Javax.xml.bind.Binder.getXMLNode(Object jaxbObject) method gets the XML element associated with the given JAXB object.

Once a JAXB object tree is associated with an XML fragment, this method enables navigation between the two trees.

Declaration

Following is the declaration for javax.xml.bind.Binder.getXMLNode(Object jaxbObject) method

public abstract XmlNode getXMLNode(Object jaxbObject)

Parameters

jaxbObject − An instance that is reachable from a prior call to a bind or update method that returned a JAXB object tree.

Return Value

Returns null if the specified JAXB object is not known to this Binder, or if it is not associated with an XML element.

Exception

IllegalArgumentException − If the jaxbObject parameter is null.

Example

The following example shows the usage of javax.xml.bind.Binder.getXMLNode(Object jaxbObject) method. To proceed, consider the following Student class which will be used to get XML node −

package com.tutorialspoint;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
 
@XmlRootElement
public class Student{
 
   String name;
   int age;
   int id;

   public String getName(){
      return name;
   }

   @XmlElement
   public void setName(String name){
      this.name = name;
   }

   public int getAge(){
      return age;
   }

   @XmlElement
   public void setAge(int age){
      this.age = age;
   }

   public int getId(){
      return id;
   }

   @XmlAttribute
   public void setId(int id){
      this.id = id;
   }
}

Now let us create main class which will be used to unmarshal/marshal ie. convert Student XML file to JAXB object and vice versa. Here we will creat Binder object using JAXBContext because we can not create Binder object directly because it is an abstract class. This example unmarshals/marshals the Student object and prints.

package com.tutorialspoint;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Binder;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

public class BinderDemo {
   public static void main(String[] args) {

      try {
         // we need a blank document to store final xml output
         DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
         DocumentBuilder docBuilder = dbf.newDocumentBuilder();
         Document document = docBuilder.parse("Student.xml");
          
         // create JAXBContext which will be used to create a Binder
         JAXBContext jc = JAXBContext.newInstance(Student.class);

         Binder<Node> binder = jc.createBinder();

         // set output as formatted one
         binder.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

         // get xml node from the document
         Node xmlNode = document.getDocumentElement();
         
         // Returns the updated JAXB object
         Student st = (Student)binder.updateJAXB(xmlNode);
         
         // get xml node associated with the binder
         xmlNode = binder.getXMLNode(st);
         
         // set node value to the document
         document.setNodeValue(xmlNode.getNodeValue());
         
         // finally print the edited object on stdout
         TransformerFactory tf = TransformerFactory.newInstance();
         Transformer t = tf.newTransformer();
         t.transform(new DOMSource(document), new StreamResult(System.out));
  
      }catch(Exception ex) {
         ex.printStackTrace();
      }
   }
}

To create document, an XML file is needed as input. The XML file is named as Student.xml−

<?xml version = "1.0" encoding = "UTF-8" standalone = "no"?>
<student id = "10">
   <age>10</age>
   <name>Zara Ali</name>
</student>

Before we proceed for compilation, we need to make sure that that we download JAXB2.xxx.jar and put it in our CLASSPATH. Once setup is ready, let us compile and run the above program, this will produce the following result −

<?xml version = "1.0" encoding = "UTF-8" standalone="no"?>
<student id = "10">
   <age>10</age>
   <name>Zara Ali</name>
</student>