unmarshalling dates using JAXB - examples

Author: catalin-burcea

jaxb/src/main/java/com/baeldung/jaxb/dateunmarshalling/Book.java

@@ -0,0 +1,31 @@
+package com.baeldung.jaxb.dateunmarshalling;
+
+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.datatype.XMLGregorianCalendar;
+
+@XmlRootElement(name = "book")
+@XmlAccessorType(XmlAccessType.NONE)
+public class Book {
+
+    @XmlElement(name = "title", required = true)
+    private String title;
+
+    @XmlElement(name = "published", required = true)
+    private XMLGregorianCalendar published;
+
+    public Book() {
+    }
+
+    public XMLGregorianCalendar getPublished() {
+        return published;
+    }
+
+    @Override
+    public String toString() {
+        return "[title: " + title + "; published: " + published.toString() + "]";
+    }
+
+}

jaxb/src/main/java/com/baeldung/jaxb/dateunmarshalling/Book2.java

@@ -0,0 +1,33 @@
+package com.baeldung.jaxb.dateunmarshalling;
+
+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.XmlJavaTypeAdapter;
+import java.util.Date;
+
+@XmlRootElement(name = "book")
+@XmlAccessorType(XmlAccessType.NONE)
+public class Book2 {
+
+    @XmlElement(name = "title", required = true)
+    private String title;
+
+    @XmlElement(name = "published", required = true)
+    @XmlJavaTypeAdapter(DateAdapter.class)
+    private Date published;
+
+    public Book2() {
+    }
+
+    public Date getPublished() {
+        return published;
+    }
+
+    @Override
+    public String toString() {
+        return "[title: " + title + "; published: " + published.toString() + "]";
+    }
+
+}

jaxb/src/main/java/com/baeldung/jaxb/dateunmarshalling/Book3.java

@@ -0,0 +1,33 @@
+package com.baeldung.jaxb.dateunmarshalling;
+
+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.XmlJavaTypeAdapter;
+import java.time.LocalDateTime;
+
+@XmlRootElement(name = "book")
+@XmlAccessorType(XmlAccessType.NONE)
+public class Book3 {
+
+    @XmlElement(name = "title", required = true)
+    private String title;
+
+    @XmlElement(name = "published", required = true)
+    @XmlJavaTypeAdapter(LocalDateTimeAdapter.class)
+    private LocalDateTime published;
+
+    public Book3() {
+    }
+
+    public LocalDateTime getPublished() {
+        return published;
+    }
+
+    @Override
+    public String toString() {
+        return "[title: " + title + "; published: " + published.toString() + "]";
+    }
+
+}

jaxb/src/main/java/com/baeldung/jaxb/dateunmarshalling/DateAdapter.java

@@ -0,0 +1,25 @@
+package com.baeldung.jaxb.dateunmarshalling;
+
+import javax.xml.bind.annotation.adapters.XmlAdapter;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+
+public class DateAdapter extends XmlAdapter<String, Date> {
+
+    private final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
+
+    @Override
+    public String marshal(Date v) {
+        synchronized (dateFormat) {
+            return dateFormat.format(v);
+        }
+    }
+
+    @Override
+    public Date unmarshal(String v) throws Exception {
+        synchronized (dateFormat) {
+            return dateFormat.parse(v);
+        }
+    }
+
+}

jaxb/src/main/java/com/baeldung/jaxb/dateunmarshalling/JaxbDateUnmarshalling.java

@@ -0,0 +1,52 @@
+package com.baeldung.jaxb.dateunmarshalling;
+
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Unmarshaller;
+import java.io.InputStream;
+
+public class JaxbDateUnmarshalling {
+
+    public static final String DEFAULT_DATE_UNMARSHALLING_FILE = "default-date-unmarshalling.xml";
+    public static final String CUSTOM_DATE_UNMARSHALLING_FILE = "custom-date-unmarshalling.xml";
+
+    public static Book unmarshalDates(InputStream inputFile) throws JAXBException {
+        JAXBContext jaxbContext = JAXBContext.newInstance(Book.class);
+        Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();
+        Book book = (Book) jaxbUnmarshaller.unmarshal(inputFile);
+        return book;
+    }
+
+    public static Book2 unmarshalDatesUsingCustomXmlAdapter(InputStream inputFile) throws JAXBException {
+        JAXBContext jaxbContext = JAXBContext.newInstance(Book2.class);
+        Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();
+        Book2 book = (Book2) jaxbUnmarshaller.unmarshal(inputFile);
+        return book;
+    }
+
+    public static Book3 unmarshalDatesUsingJava8(InputStream inputFile) throws JAXBException {
+        JAXBContext jaxbContext = JAXBContext.newInstance(Book3.class);
+        Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();
+        Book3 book = (Book3) jaxbUnmarshaller.unmarshal(inputFile);
+        return book;
+    }
+
+    public static InputStream getInputStream(String file) {
+        ClassLoader classLoader = JaxbDateUnmarshalling.class.getClassLoader();
+        return classLoader.getResourceAsStream(file);
+    }
+
+    public static void main(String[] args) {
+        try {
+            Book book = unmarshalDates(getInputStream(DEFAULT_DATE_UNMARSHALLING_FILE));
+            Book2 book2 = unmarshalDatesUsingCustomXmlAdapter(getInputStream(CUSTOM_DATE_UNMARSHALLING_FILE));
+            Book3 book3 = unmarshalDatesUsingJava8(getInputStream(CUSTOM_DATE_UNMARSHALLING_FILE));
+            System.out.println(book);
+            System.out.println(book2);
+            System.out.println(book3);
+        } catch (JAXBException e) {
+            e.printStackTrace();
+        }
+    }
+
+}

jaxb/src/main/java/com/baeldung/jaxb/dateunmarshalling/LocalDateTimeAdapter.java

@@ -0,0 +1,21 @@
+package com.baeldung.jaxb.dateunmarshalling;
+
+import javax.xml.bind.annotation.adapters.XmlAdapter;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+public class LocalDateTimeAdapter extends XmlAdapter<String, LocalDateTime> {
+
+    private DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
+
+    @Override
+    public String marshal(LocalDateTime dateTime) {
+        return dateTime.format(dateFormat);
+    }
+
+    @Override
+    public LocalDateTime unmarshal(String dateTime) {
+        return LocalDateTime.parse(dateTime, dateFormat);
+    }
+
+}

jaxb/src/main/resources/custom-date-unmarshalling.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<book>
+	<title>Book1</title>
+	<published>1979-11-28 02:31:32</published>
+</book>

jaxb/src/main/resources/default-date-unmarshalling.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<book>
+	<title>Book1</title>
+	<published>1979-11-28T02:31:32</published>
+</book>

jaxb/src/test/java/com/baeldung/jaxb/dateunmarshalling/JaxbDateUnmarshallingUnitTest.java

@@ -0,0 +1,52 @@
+package com.baeldung.jaxb.dateunmarshalling;
+
+import org.junit.Test;
+
+import javax.xml.bind.JAXBException;
+import javax.xml.datatype.DatatypeConfigurationException;
+import javax.xml.datatype.DatatypeFactory;
+import javax.xml.datatype.XMLGregorianCalendar;
+import java.io.InputStream;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.Date;
+
+import static org.junit.Assert.assertEquals;
+
+public class JaxbDateUnmarshallingUnitTest {
+
+    @Test
+    public void whenUnmarshalDatesIsCalled_ThenCorrectDateIsReturned() throws JAXBException, DatatypeConfigurationException {
+        InputStream inputStream = JaxbDateUnmarshalling.getInputStream(JaxbDateUnmarshalling.DEFAULT_DATE_UNMARSHALLING_FILE);
+        XMLGregorianCalendar expected = DatatypeFactory.newInstance().newXMLGregorianCalendar("1979-11-28T02:31:32");
+
+        Book book = JaxbDateUnmarshalling.unmarshalDates(inputStream);
+
+        assertEquals(expected, book.getPublished());
+    }
+
+    @Test
+    public void whenUnmarshalDatesUsingCustomXmlAdapterIsCalled_ThenCorrectDateIsReturned() throws JAXBException, ParseException {
+        InputStream inputStream = JaxbDateUnmarshalling.getInputStream(JaxbDateUnmarshalling.CUSTOM_DATE_UNMARSHALLING_FILE);
+        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
+        Date expected = format.parse("1979-11-28 02:31:32");
+
+        Book2 book = JaxbDateUnmarshalling.unmarshalDatesUsingCustomXmlAdapter(inputStream);
+
+        assertEquals(expected, book.getPublished());
+    }
+
+    @Test
+    public void whenUnmarshalDatesUsingJava8IsCalled_ThenCorrectDateIsReturned() throws JAXBException {
+        InputStream inputStream = JaxbDateUnmarshalling.getInputStream(JaxbDateUnmarshalling.CUSTOM_DATE_UNMARSHALLING_FILE);
+        DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
+        LocalDateTime expected = LocalDateTime.parse("1979-11-28 02:31:32", dateFormat);
+
+        Book3 book = JaxbDateUnmarshalling.unmarshalDatesUsingJava8(inputStream);
+
+        assertEquals(expected, book.getPublished());
+    }
+
+}