{"id":8918,"date":"2013-02-22T13:00:30","date_gmt":"2013-02-22T11:00:30","guid":{"rendered":"http:\/\/www.javacodegeeks.com\/?p=8918"},"modified":"2015-01-05T23:25:55","modified_gmt":"2015-01-05T21:25:55","slug":"jaxb-tutorial-getting-started","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2013\/02\/jaxb-tutorial-getting-started.html","title":{"rendered":"JAXB tutorial – Getting Started"},"content":{"rendered":"

Note:<\/strong> Check out our JAXB Tutorial for Java XML Binding \u2013 The ULTIMATE Guide<\/a><\/em><\/p>\n

What is JAXB?<\/h2>\n

JAXB stands for Java architecture for XML binding.It is used to convert XML to java object and java object to XML.JAXB defines an API for reading and writing Java objects to and from XML documents.Unlike SAX and DOM,we don’t need to be aware of XML parsing techniques.<\/p>\n

\"\"<\/a><\/p>\n

 
\nThere are two operations you can perform using JAXB<\/p>\n

    \n
  1. Marshalling<\/b> :Converting a java object to XML<\/li>\n
  2. UnMarshalling <\/b>:Converting a XML to java object<\/li>\n<\/ol>\n

    JAXB Tutorial<\/h2>\n

    We will create a java program to marshal and unmarshal.<\/p>\n

    For Marshalling:<\/h4>\n

    \"\"<\/a><\/p>\n

    For Unmarshalling:<\/h4>\n

    \"\"<\/a><\/p>\n

    Java program:<\/h2>\n

    With the help of annotations and API provided by JAXB,converting a java object to XML and vice versa become very easy.<\/p>\n

    1.Country.java<\/h2>\n

    A Java object which will be used to convert to and from XML<\/p>\n

    Create Country.java in src->org.arpit.javapostsforlearning.jaxb<\/p>\n

    package org.arpit.javapostsforlearning.jaxb;\r\n\r\nimport java.util.ArrayList;\r\n\r\nimport javax.xml.bind.annotation.XmlElement;\r\nimport javax.xml.bind.annotation.XmlElementWrapper;\r\nimport javax.xml.bind.annotation.XmlRootElement;\r\nimport javax.xml.bind.annotation.XmlType;\r\n\r\n\/\/Below annotation defines root element of XML file\r\n@XmlRootElement\r\n\/\/You can define order in which elements will be created in XML file\r\n\/\/Optional\r\n@XmlType(propOrder = { 'countryName', 'countryPopulation', 'listOfStates'})\r\npublic class Country {\r\n\r\n private String countryName;\r\n private double countryPopulation;\r\n\r\n private ArrayList<state> listOfStates;\r\n public Country() {\r\n\r\n }\r\n public String getCountryName() {\r\n  return countryName;\r\n }\r\n @XmlElement\r\n public void setCountryName(String countryName) {\r\n  this.countryName = countryName;\r\n }\r\n public double getCountryPopulation() {\r\n  return countryPopulation;\r\n }\r\n\r\n @XmlElement\r\n public void setCountryPopulation(double countryPopulation) {\r\n  this.countryPopulation = countryPopulation;\r\n }\r\n\r\n public ArrayList<state> getListOfStates() {\r\n  return listOfStates;\r\n }\r\n\r\n \/\/ XmLElementWrapper generates a wrapper element around XML representation\r\n   @XmlElementWrapper(name = 'stateList')\r\n  \/\/ XmlElement sets the name of the entities in collection\r\n   @XmlElement(name = 'state')\r\n public void setListOfStates(ArrayList<state> listOfStates) {\r\n  this.listOfStates = listOfStates;\r\n }\r\n\r\n}<\/pre>\n
    @XmlRootElement:<\/b>This annotation defines root element of XML file.
    \n@XmlType(propOrder = {‘list of attributes in order’})<\/b>:This is used to define order of elements in XML file.This is optional.
    \n@XmlElement:<\/b>This is used to define element in XML file.It sets name of entity.
    \n@XmlElementWrapper(name = ‘name to be given to that wrapper’):<\/b>It generates a wrapper element around XML representation.E.g.In above example, it will generate <stateList>
    \naround each <state> element
     
    <\/div> <\/div><\/p>\n
     2.State.java <\/h2>\n
    package org.arpit.javapostsforlearning.jaxb;\r\n\r\nimport javax.xml.bind.annotation.XmlRootElement;\r\n\r\n\/\/Below statement means that class 'Country.java' is the root-element of our example\r\n@XmlRootElement(namespace = 'org.arpit.javapostsforlearning.jaxb.Country')\r\npublic class State {\r\n\r\n private String stateName;\r\n long statePopulation;\r\n\r\n public State()\r\n {\r\n\r\n }\r\n public State(String stateName, long statePopulation) {\r\n  super();\r\n  this.stateName = stateName;\r\n  this.statePopulation = statePopulation;\r\n }\r\n\r\n public String getStateName() {\r\n  return stateName;\r\n }\r\n\r\n public void setStateName(String stateName) {\r\n  this.stateName = stateName;\r\n }\r\n\r\n public long getStatePopulation() {\r\n  return statePopulation;\r\n }\r\n\r\n public void setStatePopulation(long statePopulation) {\r\n  this.statePopulation = statePopulation;\r\n }\r\n}<\/pre>\n
    3.JAXBJavaToXml.java <\/h2>\n
    package org.arpit.javapostsforlearning.jaxb;\r\n\r\nimport java.io.File;\r\nimport java.util.ArrayList;\r\n\r\nimport javax.xml.bind.JAXBContext;\r\nimport javax.xml.bind.JAXBException;\r\nimport javax.xml.bind.Marshaller;\r\n\r\npublic class JAXBJavaToXml {\r\n public static void main(String[] args) {\r\n\r\n  \/\/ creating country object\r\n   Country countryIndia=new Country();  \r\n   countryIndia.setCountryName('India');\r\n   countryIndia.setCountryPopulation(5000000);\r\n\r\n   \/\/ Creating listOfStates\r\n   ArrayList<state> stateList=new ArrayList<state>();\r\n   State mpState=new State('Madhya Pradesh',1000000);\r\n   stateList.add(mpState);\r\n   State maharastraState=new State('Maharastra',2000000);\r\n   stateList.add(maharastraState);\r\n\r\n   countryIndia.setListOfStates(stateList);\r\n\r\n  try {\r\n\r\n   \/\/ create JAXB context and initializing Marshaller\r\n   JAXBContext jaxbContext = JAXBContext.newInstance(Country.class);\r\n   Marshaller jaxbMarshaller = jaxbContext.createMarshaller();\r\n\r\n   \/\/ for getting nice formatted output\r\n   jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);\r\n\r\n   \/\/specify the location and name of xml file to be created\r\n   File XMLfile = new File('C:\\\\arpit\\\\CountryRecord.xml');\r\n\r\n   \/\/ Writing to XML file\r\n   jaxbMarshaller.marshal(countryIndia, XMLfile); \r\n   \/\/ Writing to console\r\n   jaxbMarshaller.marshal(countryIndia, System.out); \r\n\r\n  } catch (JAXBException e) {\r\n   \/\/ some exception occured\r\n   e.printStackTrace();\r\n  }\r\n\r\n }\r\n}<\/pre>\n
    After running above program,you will get following output<\/p>\n
    Console output:<\/h4>\n
    <?xml version='1.0' encoding='UTF-8' standalone='yes'?>\r\n<country xmlns:ns2='org.arpit.javapostsforlearning.jaxb.Country'>\r\n    <countryName>India<\/countryName>\r\n    <countryPopulation>5000000.0<\/countryPopulation>\r\n    <stateList>\r\n        <state>\r\n            <stateName>Madhya Pradesh<\/stateName>\r\n            <statePopulation>1000000<\/statePopulation>\r\n        <\/state>\r\n        <state>\r\n            <stateName>Maharastra<\/stateName>\r\n            <statePopulation>2000000<\/statePopulation>\r\n        <\/state>\r\n    <\/stateList>\r\n<\/country><\/pre>\n
    Now we will read above generated XML and retrieve country object from it.<\/p>\n
     4.JAXBXMLToJava.java <\/h2>\n
    package org.arpit.javapostsforlearning.jaxb;\r\n\r\nimport java.io.File;\r\nimport java.util.ArrayList;\r\nimport javax.xml.bind.JAXBContext;\r\nimport javax.xml.bind.JAXBException;\r\nimport javax.xml.bind.Unmarshaller;\r\n\r\npublic class JAXBXMLToJava {\r\n public static void main(String[] args) {\r\n\r\n  try {\r\n\r\n   \/\/ create JAXB context and initializing Marshaller\r\n   JAXBContext jaxbContext = JAXBContext.newInstance(Country.class);\r\n\r\n   Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();\r\n\r\n   \/\/ specify the location and name of xml file to be read\r\n   File XMLfile = new File('C:\\\\arpit\\\\CountryRecord.xml');\r\n\r\n   \/\/ this will create Java object - country from the XML file\r\n   Country countryIndia = (Country) jaxbUnmarshaller.unmarshal(XMLfile);\r\n\r\n   System.out.println('Country Name: '+countryIndia.getCountryName());\r\n   System.out.println('Country Population: '+countryIndia.getCountryPopulation());\r\n\r\n   ArrayList<state> listOfStates=countryIndia.getListOfStates();\r\n\r\n   int i=0; \r\n   for(State state:listOfStates)\r\n   {\r\n    i++;\r\n    System.out.println('State:'+i+' '+state.getStateName());\r\n   }\r\n\r\n  } catch (JAXBException e) {\r\n   \/\/ some exception occured\r\n   e.printStackTrace();\r\n  }\r\n\r\n }\r\n}<\/pre>\n
    After running above program,you will get following output:<\/p>\n
     Console output: <\/h4>\n
    Country Name: India\r\nCountry Population: 5000000.0\r\nState:1 Madhya Pradesh\r\nState:2 Maharastra<\/pre>\n
     JAXB advantages: <\/h4>\n