Jaxb Appointment Format Event Using Tone | Coffee Appointment To Xml Datetime String Conversion

One of the mutual work spell marshaling Java object to XML String using JAXB is the default format of engagement as well as fourth dimension provided past times JAXB. When JAXB converts whatever Date type object or XMLGregorianCalendar to XML String, just xsd:dateTime element, it past times default prints unformatted engagement e.g. 2012-05-17T09:20:00-04:30. Since most of the existent world, Java application has a requirement to impress engagement inwards a especial format similar dd-MM-yyyy or include engagement as well as fourth dimension inwards format dd-MM-yyyy HH:mm:ss, it becomes a problem. Thankfully, JAXB is real extensible as well as provides hooks as well as adapters to customize marshaling as well as unmarshaling process. You tin displace define an extension of XmlAdapter to command as well as customize marshaling as well as unmarshaling or whatever Java type depending upon yours need.

In this JAXB tutorial, nosotros volition come across an instance of customizing JAXB to format engagement as well as fourth dimension inwards an application specific format.

For our purpose, nosotros volition utilization the SimpleDateFormat class, which has its ain issues, but that's ok for demonstration purpose. To acquire a clarity of what is the number amongst the engagement format, as well as what nosotros are doing inwards this example, consider next xml snippet, which is created from our Employee object, without formatting Date, XML volition expect like:

<employee> <name>John</name> <dateofbirth>1985-01-15T18:30:00-04:00</dateofbirth> <dateofjoining>2012-05-17T09:20:00-04:30</dateofjoining> </employee> 

While later using XmlAdapter for controlling marshaling of engagement object inwards JAXB, our XML String snippet volition expect similar below:

XML String later formatting engagement inwards dd-MM-yyyy HH:mm:ss format

<employee>  <name>John</name>  <dateofbirth>15-01-1985 18:30:00</dateofbirth>  <dateofjoining>17-05-2012 09:20:00</dateofjoining> </employee> 

You tin displace come across that, inwards the minute XML, dates are properly formatted including both engagement as well as fourth dimension information. You tin displace fifty-fifty farther customize it into several other engagement formats e.g. MM/dd/yyyy, yous but take to hollo upward SimpleDateFormat syntax for formatting dates, equally shown here.

JAXB Date Format Example

Here is the consummate code instance of formatting dates inwards JAXB. It allows yous to specify Adapters, which tin displace hold out used for marshaling as well as unmarshaling dissimilar types of object, for example, yous tin displace specify DateTimeAdapter for converting Date to String during marshaling, as well as XML String to Date during unmarshaling.

Apart from writing your ain Adapter, which should extend the XmlAdapter class, yous likewise take to utilization notation @XmlJavaTypeAdapter to specify that JAXB should utilization that adapter for marshaling as well as unmarshalling of a especial object.

In this JAXB tutorial, nosotros bring written our ain DateTimeAdapter, which extends XmlAdapter as well as overrides marshal(Date object) as well as unmarshal(String xml) methods. JAXB calls marshal method, spell converting Java Object to XML document, as well as unmarshal method to bind XML document to Java object.

We are likewise using SimpleDateFormat class, to format Date object into dd-MM-yyyy HH:mm:ss format, which impress engagement equally 15-01-1985 18:30:00. By the way, hold out careful spell using SimpleDateFormat, equally it's non thread-safe.




Java Program to convert Java Object to XML amongst formatted Dates

import java.io.StringWriter; import java.text.DateFormat; import java.text.SimpleDateFormat; import java.util.Calendar; import java.util.Date; import java.util.GregorianCalendar;  import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBException; import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; import javax.xml.bind.annotation.adapters.XmlAdapter; import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;  /**  *  * JAXB tutorial to format Date to XML String spell converting Java object to  * XML documents i.e. during marshalling.  *  * @author Javin Paul  */ public class JAXBDateFormatTutorial {      public static void main(String args[]) {            Date dob = new GregorianCalendar(1985,Calendar.JANUARY, 15, 18, 30).getTime();        Date doj = new GregorianCalendar(2012,Calendar.MAY, 17, 9, 20).getTime();                  Employee privy = new Employee("John", dob, doj);          // Marshaling Employee object to XML using JAXB        JAXBContext ctx = null;        StringWriter author = new StringWriter();          try{            ctx = JAXBContext.newInstance(Employee.class);            ctx.createMarshaller().marshal(john, writer);            System.out.println("Employee object equally XML");            System.out.println(writer);              }catch(JAXBException ex){            ex.printStackTrace();        }     }  }

When yous volition run this programme it volition impress the Employee object inwards XML equally shown below:

Employee object equally XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <employee> <name>John</name> <dateOfBirth>15-01-1985 18:30:00</dateOfBirth> <dateOfJoining>17-05-2012 09:20:00</dateOfJoining> </employee>

You tin displace come across that dates are nicely formatted as well as in that location is no to a greater extent than T inwards betwixt equally it was before.

In this program, in that location are iii psyche classes: Employee, DateTimeAdapter, as well as JAXBDateFormatTutorial, each course of pedagogy is coded inwards their respective file because they are populace classes e.g. Employee.java contains Employee class. If yous desire to include thus inwards the same file, but take the public modifier from Employee as well as DateTimeAdapter class.

The Employee course of pedagogy is your domain object spell DateTimeAdapter is an extension of XmlAdapter to format dates spell converting XML to Java object as well as vice-versa. As I said, JAXB is real extensible as well as provides a lot of hooks where yous tin displace insert your ain code for customization. If yous desire to larn to a greater extent than almost advanced usage of JAXB, I propose yous reading Core Java Volume II - Advanced Features past times Cay S. Horstmann, ane of the best books to larn XML parsing inwards Java.

Employee.java

@XmlRootElement(name="employee") @XmlAccessorType(XmlAccessType.FIELD)   public class Employee{     @XmlElement(name="name")     private String name;      @XmlElement(name="dateOfBirth")         @XmlJavaTypeAdapter(DateTimeAdapter.class)     private Date dateOfBirth;      @XmlElement(name="dateOfJoining")     @XmlJavaTypeAdapter(DateTimeAdapter.class)     private Date dateOfJoining;      // no-arg default constructor for JAXB     public Employee(){}      public Employee(String name, Date dateOfBirth, Date dateOfJoining) {         this.name = name;         this.dateOfBirth = dateOfBirth;         this.dateOfJoining = dateOfJoining;     }      public Date getDateOfBirth() {         return dateOfBirth;     }      public void setDateOfBirth(Date dateOfBirth) {         this.dateOfBirth = dateOfBirth;     }      public Date getDateOfJoining() {         return dateOfJoining;     }      public void setDateOfJoining(Date dateOfJoining) {         this.dateOfJoining = dateOfJoining;     }      public String getName() {         return name;     }      public void setName(String name) {         this.name = name;     }      @Override     public String toString() {         return "Employee{" + "name=" + cite + ", dateOfBirth="                 + dateOfBirth + ", dateOfJoining=" + dateOfJoining + '}';      }  }

DateTimeAdapter.java

public class DateTimeAdapter extends XmlAdapter<String, Date>{     private final DateFormat dateFormat = new SimpleDateFormat("dd-MM-yyyy HH:mm:ss");      @Override     public Date unmarshal(String xml) throws Exception {         return dateFormat.parse(xml);     }      @Override     public String marshal(Date object) throws Exception {         return dateFormat.format(object);     }  }

Things to Remember

Here are a twain of of import things to hollo upward while

1) Don't forget to render a no declaration default constructor for your domain object e.g. Employee, failing to exercise volition effect inwards the next fault spell marshaling Java Object to XML String:

com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException: 1 counts of IllegalAnnotationExceptions Employee does non bring a no-arg default constructor.
this work is related to the next location:

at Employee
at com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException$Builder.check(IllegalAnnotationsException.java:91)
at com.sun.xml.internal.bind.v2.runtime.JAXBContextImpl.getTypeInfoSet(JAXBContextImpl.java:436)

at com.sun.xml.internal.bind.v2.runtime.JAXBContextImpl.(JAXBContextImpl.java:277)

That's all on How to format Dates inwards JAXB. We bring non only learned Date formatting during marshaling of the Date object but likewise seen how to customize JAXB marshaling as well as unmarshalling process. You tin displace utilization this technique to customize marshaling of whatever Java type e.g. BigDecimal, float, or double etc. Just hollo upward to utilization notation @XmlJavaTypeAdapter to specify the cite of your custom engagement as well as fourth dimension Adapter to JAXB marshaller.

Further Learning
Java In-Depth: Become a Complete Java Engineer!
Master Java Web Services as well as REST API amongst Spring Boot
answer)

Step past times Step direct to parsing XML using SAX parser inwards Java? (tutorial)

Top 10 XML Interview Questions for Java Programmers? (FAQ)

How to read XML file using DOM Parser inwards Java? (tutorial)

How to escape XML Special grapheme inwards Java String? (tutorial)

Top 10 XSLT Transformation Interview Questions? (FAQ)

How to parse XML document using JDOM Parser inwards Java? (tutorial)

How to exercise as well as evaluate XPath Expressions inwards Java? (guide)

Thanks for reading this tutorial, if yous similar this tutorial thus delight part amongst your friends as well as colleagues. If yous bring whatever proffer as well as feedback thus delight part amongst us.

P.S. - If yous are interested inwards learning how to bargain amongst XML inwards Java inwards to a greater extent than details, yous tin displace read Java as well as XML - Solutions of Real World Problem past times Brett McLaughlin. It covers everything amongst honour to parsing XML e.g. SAX, DOM, as well as StAX parser, JAXB, XPath, XSLT, as well as JAXB. One of the skillful majority for advanced Java developers.