Javax.xml.bind.Binder.marshal() Method

---

---

Description

The Javax.xml.bind.Binder.marshal(Object jaxbObject, XmlNode xmlNode) method marshals i.e. converts a JAXB object tree to a new XML document.

This method is similar to Marshaller.marshal(Object, Node) but it also capabale to maintain the association between JAXB objects and the produced XML nodes, enabling future update operations such as updateXML() or updateJAXB() on the XML nodes.

Declaration

Following is the declaration for Javax.xml.bind.Binder.marshal(Object jaxbObject, XmlNode xmlNode) method

public abstract void marshal(Object jaxbObject, XmlNode xmlNode)

Parameters

• jaxbObject − The content tree to be marshalled.

• xmlNode − This is the XML node where children nodes can be added.

Return Value

This method does not return any value.

Exception

• JAXBException − If any unexpected problem occurs during the marshalling.

• MarshalException − If the ValidationEventHandler returns false from its handleEvent method or the Binder is unable to marshal jaxbObject

• IllegalArgumentException − If any of the method parameters are null.

Example

The following example shows the usage of Javax.xml.bind.Binder.marshal() method. To proceed, consider the following Student class which will be used to have objects for marshalling purpose −

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 marshal ie. convert Student object into an XML file. Here we will creat Binder object using JAXBContext because we can not create Binder object directly because it is an abstract class. This example marshals the Student object and prints it at STDOUT, but in practical scenario you can store the object in any file as an XML node.

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) {
  
      // create a Student object and set its properties
      Student student = new Student();
      student.setId(10);
      student.setName("Zara Ali");
      student.setAge(10);

      try {
         // we need a blank document to store final xml output
         DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
         DocumentBuilder docBuilder = dbf.newDocumentBuilder();
         Document document = docBuilder.newDocument();
          
         // 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);

         // let's marshal the object and store in document
         binder.marshal(student, document);
         
         // finally print the marshalled 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();
      }
   }
}

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>