org.apache.juneau.swaps.TemporalDateSwap Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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 org.apache.juneau.swaps;
import java.time.*;
import java.time.format.*;
import java.time.temporal.*;
import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.swap.*;
/**
* Swap that converts {@link Date} objects to and from strings.
*
*
* Uses the {@link DateTimeFormatter} class for converting {@link Date} objects.
*
*
See Also:
* - Swaps
*
*/
public class TemporalDateSwap extends StringSwap {
/**
* Default swap to {@link DateTimeFormatter#BASIC_ISO_DATE}.
*
* Example: "20111203"
*/
public static class BasicIsoDate extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new BasicIsoDate();
/** Constructor.*/
public BasicIsoDate() {
super("BASIC_ISO_DATE");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_DATE}.
*
* Example: "2011-12-03+01:00" or "2011-12-03"
*/
public static class IsoDate extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoDate();
/** Constructor.*/
public IsoDate() {
super("ISO_DATE");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_DATE_TIME}.
*
* Example: "2011-12-03T10:15:30+01:00[Europe/Paris]"
*/
public static class IsoDateTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoDateTime();
/** Constructor.*/
public IsoDateTime() {
super("ISO_DATE_TIME");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_INSTANT}.
*
* Example: "2011-12-03T10:15:30Z"
*/
public static class IsoInstant extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoInstant();
/** Constructor.*/
public IsoInstant() {
super("ISO_INSTANT");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_LOCAL_DATE}.
*
* Example: "2011-12-03"
*/
public static class IsoLocalDate extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoLocalDate();
/** Constructor.*/
public IsoLocalDate() {
super("ISO_LOCAL_DATE");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_LOCAL_DATE_TIME}.
*
* Example: "2011-12-03T10:15:30"
*/
public static class IsoLocalDateTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoLocalDateTime();
/** Constructor.*/
public IsoLocalDateTime() {
super("ISO_LOCAL_DATE_TIME");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_LOCAL_TIME}.
*
* Example: "10:15:30"
*/
public static class IsoLocalTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoLocalTime();
/** Constructor.*/
public IsoLocalTime() {
super("ISO_LOCAL_TIME");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_OFFSET_DATE}.
*
* Example: "2011-12-03"
*/
public static class IsoOffsetDate extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoOffsetDate();
/** Constructor.*/
public IsoOffsetDate() {
super("ISO_OFFSET_DATE");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_OFFSET_DATE_TIME}.
*
* Example: "2011-12-03T10:15:30+01:00"
*/
public static class IsoOffsetDateTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoOffsetDateTime();
/** Constructor.*/
public IsoOffsetDateTime() {
super("ISO_OFFSET_DATE_TIME");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_OFFSET_TIME}.
*
* Example: "10:15:30+01:00"
*/
public static class IsoOffsetTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoOffsetTime();
/** Constructor.*/
public IsoOffsetTime() {
super("ISO_OFFSET_TIME");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_ORDINAL_DATE}.
*
* Example: "2012-337"
*/
public static class IsoOrdinalDate extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoOrdinalDate();
/** Constructor.*/
public IsoOrdinalDate() {
super("ISO_ORDINAL_DATE");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_TIME}.
*
* Example: "10:15:30+01:00" or "10:15:30"
*/
public static class IsoTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoTime();
/** Constructor.*/
public IsoTime() {
super("ISO_TIME");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_WEEK_DATE}.
*
* Example: "2012-W48-6"
*/
public static class IsoWeekDate extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoWeekDate();
/** Constructor.*/
public IsoWeekDate() {
super("ISO_WEEK_DATE");
}
}
/**
* Default swap to {@link DateTimeFormatter#ISO_ZONED_DATE_TIME}.
*
* Example: "2011-12-03T10:15:30+01:00[Europe/Paris]"
*/
public static class IsoZonedDateTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new IsoZonedDateTime();
/** Constructor.*/
public IsoZonedDateTime() {
super("ISO_ZONED_DATE_TIME");
}
}
/**
* Default swap to {@link DateTimeFormatter#RFC_1123_DATE_TIME}.
*
* Example: "Tue, 3 Jun 2008 11:05:30 GMT"
*/
public static class Rfc1123DateTime extends TemporalDateSwap {
/** Default instance.*/
public static final TemporalDateSwap DEFAULT = new Rfc1123DateTime();
/** Constructor.*/
public Rfc1123DateTime() {
super("RFC_1123_DATE_TIME");
}
}
private final DateTimeFormatter formatter;
/**
* Constructor.
*
* @param pattern The timestamp format or name of predefined {@link DateTimeFormatter}.
*/
public TemporalDateSwap(String pattern) {
super(Date.class);
this.formatter = DateUtils.getFormatter(pattern);
}
@Override /* ObjectSwap */
public String swap(BeanSession session, Date o) throws Exception {
if (o == null)
return null;
return formatter.format(o.toInstant().atZone(session.getTimeZoneId()));
}
@Override /* ObjectSwap */
public Date unswap(BeanSession session, String f, ClassMeta hint) throws Exception {
if (f == null)
return null;
ZoneId offset = session.getTimeZoneId();
TemporalAccessor ta = new DefaultingTemporalAccessor(formatter.parse(f), offset);
return Date.from(ZonedDateTime.from(ta).toInstant());
}
}