com.tomtom.speedtools.xmladapters.DateAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Consists of a lot of handy classes and utilities for your main Java application, like buffers, checksum calculations, locale handling, time conversion and more.
There is a newer version: 3.4.4
Show newest version
/*
 * Copyright (C) 2012-2019, TomTom (http://tomtom.com).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.tomtom.speedtools.xmladapters;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.tomtom.speedtools.xmladapters.DateTimeAdapter.JsonDateTimeStringDeserializer;
import com.tomtom.speedtools.xmladapters.DateTimeAdapter.JsonSerializerWithSecondsResolution;
import com.tomtom.speedtools.xmladapters.DateTimeAdapter.XMLAdapterWithSecondsResolution;
import org.joda.time.DateTime;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.annotation.adapters.XmlAdapter;
import java.io.IOException;
import java.util.Date;


/**
 * Adapter class for serializing and deserializing dates in XML/JSON.
 */
public final class DateAdapter {

    private static final XMLAdapterWithSecondsResolution XML_DATE_TIME_ADAPTER = new XMLAdapterWithSecondsResolution();
    private static final JsonSerializerWithSecondsResolution JSON_DATE_TIME_SERIALIZER = new JsonSerializerWithSecondsResolution();
    private static final JsonDateTimeStringDeserializer JSON_DATE_TIME_DESERIALIZER = new JsonDateTimeStringDeserializer();

    private DateAdapter() {
        // Prevent instantiation.
    }

    /**
     * The class DateAdapter.XMLAdapter can be used as an XmlAdapter for JAX-B annotations. It marshals/unmarshals a date to/from a normalized UTC string format. This format should be used in all communications.
     *
     * Example of using the Xml adapter for a JAX-B annotated resource:
     *
     *      * XmlRootElement XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
     * public class MyClass {
     *     XmlJavaTypeAdapter(value = DateAdapter.class) private Date issueDate;
     *     ...
     * }
     * 
     */
    public static class XMLAdapter extends XmlAdapter {

        /**
         * Unmarshall a Date object from the ISO8601 standard.
         *
         * @param v Valid date string of ISO8601 format.
         * @return Date Valid Date object, or null if the input was null.
         * @see http://tools.ietf.org/html/rfc3339
         */
        @Nullable
        @Override
        public Date unmarshal(@Nullable final String v) {
            final DateTime dateTime = XML_DATE_TIME_ADAPTER.unmarshal(v);
            if (dateTime == null) {
                return null;
            }
            return dateTime.toDate();
        }

        /**
         * Marshall a Date object into the format: YYYY-MM-DDTHH:mm:ssZ, in UTC time.
         *
         * @param v Valid date.
         * @return Date string, formatted: YYYY-MM-DDTHH:mm:ssZ (UTC time), or null if the input was null.
         */
        @Nullable
        @Override
        public String marshal(@Nullable final Date v) {
            if (v == null) {
                return null;
            }
            return XML_DATE_TIME_ADAPTER.marshal(new DateTime(v));
        }
    }

    public static class JsonDateSerializer extends JsonSerializer {

        @Override
        public void serialize(@Nonnull final Date t, @Nonnull final JsonGenerator jsonGenerator, @Nullable final SerializerProvider serializerProvider) throws IOException {
            JSON_DATE_TIME_SERIALIZER.serialize(new DateTime(t), jsonGenerator, serializerProvider);
        }
    }

    public static class JsonDateDeserializer extends JsonDeserializer {

        @Nullable
        @Override
        public Date deserialize(@Nonnull final JsonParser jsonParser, @Nullable final DeserializationContext deserializationContext) throws IOException {
            final DateTime dateTime = JSON_DATE_TIME_DESERIALIZER.deserialize(jsonParser, deserializationContext);
            if (dateTime == null) {
                return null;
            }
            return dateTime.toDate();
        }
    }
}