org.apache.juneau.transforms

Class TemporalSwap

java.lang.Object

org.apache.juneau.transform.PojoSwap<T,String>

org.apache.juneau.transform.StringSwap<Temporal>

org.apache.juneau.transforms.TemporalSwap

Direct Known Subclasses:

TemporalSwap.BasicIsoDate, TemporalSwap.IsoDate, TemporalSwap.IsoDateTime, TemporalSwap.IsoInstant, TemporalSwap.IsoLocalDate, TemporalSwap.IsoLocalDateTime, TemporalSwap.IsoLocalTime, TemporalSwap.IsoOffsetDate, TemporalSwap.IsoOffsetDateTime, TemporalSwap.IsoOffsetTime, TemporalSwap.IsoOrdinalDate, TemporalSwap.IsoTime, TemporalSwap.IsoWeekDate, TemporalSwap.IsoYear, TemporalSwap.IsoYearMonth, TemporalSwap.IsoZonedDateTime, TemporalSwap.Rfc1123DateTime

public class TemporalSwap
extends StringSwap<Temporal>

Swap that converts Temporal objects to strings.

Uses the DateTimeFormatter class for converting Temporal objects to and from strings.

Supports any of the following temporal objects:

• HijrahDate
• Instant
• JapaneseDate
• LocalDate
• LocalDateTime
• LocalTime
• MinguoDate
• OffsetDateTime
• OffsetTime
• ThaiBuddhistDate
• Year
• YearMonth
• ZonedDateTime

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemporalSwap.BasicIsoDate Default swap to DateTimeFormatter.BASIC_ISO_DATE.
static class	TemporalSwap.IsoDate Default swap to DateTimeFormatter.ISO_DATE.
static class	TemporalSwap.IsoDateTime Default swap to DateTimeFormatter.ISO_DATE_TIME.
static class	TemporalSwap.IsoInstant Default swap to DateTimeFormatter.ISO_INSTANT.
static class	TemporalSwap.IsoLocalDate Default swap to DateTimeFormatter.ISO_LOCAL_DATE.
static class	TemporalSwap.IsoLocalDateTime Default swap to DateTimeFormatter.ISO_LOCAL_DATE_TIME.
static class	TemporalSwap.IsoLocalTime Default swap to DateTimeFormatter.ISO_LOCAL_TIME.
static class	TemporalSwap.IsoOffsetDate Default swap to DateTimeFormatter.ISO_OFFSET_DATE.
static class	TemporalSwap.IsoOffsetDateTime Default swap to DateTimeFormatter.ISO_OFFSET_DATE_TIME.
static class	TemporalSwap.IsoOffsetTime Default swap to DateTimeFormatter.ISO_OFFSET_TIME.
static class	TemporalSwap.IsoOrdinalDate Default swap to DateTimeFormatter.ISO_ORDINAL_DATE.
static class	TemporalSwap.IsoTime Default swap to DateTimeFormatter.ISO_TIME.
static class	TemporalSwap.IsoWeekDate Default swap to DateTimeFormatter.ISO_WEEK_DATE.
static class	TemporalSwap.IsoYear Default swap to DateTimeFormatter.ISO_WEEK_DATE.
static class	TemporalSwap.IsoYearMonth Default swap to DateTimeFormatter.ISO_WEEK_DATE.
static class	TemporalSwap.IsoZonedDateTime Default swap to DateTimeFormatter.ISO_ZONED_DATE_TIME.
static class	TemporalSwap.Rfc1123DateTime Default swap to DateTimeFormatter.RFC_1123_DATE_TIME.

Field Summary

Fields inherited from class org.apache.juneau.transform.PojoSwap

NULL

Constructor Summary

Constructors

Constructor and Description
TemporalSwap(String pattern, boolean zoneOptional) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Temporal	convertToSerializable(BeanSession session, Temporal t) Converts the specified temporal object to a form suitable to be serialized using any pattern.
String	swap(BeanSession session, Temporal o) If this transform is to be used to serialize non-serializable POJOs, it must implement this method.
Temporal	unswap(BeanSession session, String f, ClassMeta<?> hint) If this transform is to be used to reconstitute POJOs that aren't true Java beans, it must implement this method.
protected boolean	zoneOptional() Returns true if the time zone on the pattern is optional.

Methods inherited from class org.apache.juneau.transform.PojoSwap

forMediaTypes, forMediaTypes, getNormalClass, getSwapClass, getSwapClassMeta, isNormalObject, isSwappedObject, match, swap, toString, unswap, withTemplate, withTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TemporalSwap

public TemporalSwap(String pattern,
                    boolean zoneOptional)

Constructor.

Parameters:

pattern - The timestamp format or name of predefined DateTimeFormatter.

zoneOptional - true if the time zone on the pattern is optional.

Method Detail

zoneOptional

protected boolean zoneOptional()

Returns true if the time zone on the pattern is optional.

If it's not optional, then local dates/times must be converted into zoned times using the session time zone. Otherwise, local date/times are fine.

Returns:

true if the time zone on the pattern is optional.

swap

public String swap(BeanSession session,
                   Temporal o)
            throws Exception

Description copied from class: PojoSwap

If this transform is to be used to serialize non-serializable POJOs, it must implement this method.

The object must be converted into one of the following serializable types:

• String
• Number
• Boolean
• Collection containing anything on this list.
• Map containing anything on this list.
• A java bean with properties of anything on this list.
• An array of anything on this list.

Overrides:

swap in class StringSwap<Temporal>

Parameters:

session - The bean session to use to get the class meta. This is always going to be the same bean context that created this swap.

o - The object to be transformed.

Returns:

The transformed object.

Throws:

Exception - If a problem occurred trying to convert the output.

convertToSerializable

protected Temporal convertToSerializable(BeanSession session,
                                         Temporal t)

Converts the specified temporal object to a form suitable to be serialized using any pattern.

Parameters:

session - The current bean session.

t - The temporal object to convert.

Returns:

The converted temporal object.

unswap

public Temporal unswap(BeanSession session,
                       String f,
                       ClassMeta<?> hint)
                throws Exception

Description copied from class: PojoSwap

If this transform is to be used to reconstitute POJOs that aren't true Java beans, it must implement this method.

Overrides:

unswap in class StringSwap<Temporal>

Parameters:

session - The bean session to use to get the class meta. This is always going to be the same bean context that created this swap.

f - The transformed object.

hint - If possible, the parser will try to tell you the object type being created. For example, on a serialized date, this may tell you that the object being created must be of type GregorianCalendar.
This may be null if the parser cannot make this determination.

Returns:

The narrowed object.

Throws:

Exception - If this method is not implemented.