Package org.jibx.runtime
Class JodaConvert
java.lang.Object
org.jibx.runtime.JodaConvert
Utility class supplying static methods for Joda date/time conversions. The actual serializer/deserializer methods are
all public so that they'll be included in JavaDocs; support methods are protected, so that they'll be exposed for
user classes extending this class.
- Author:
- Dennis M. Sosnoski
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected static DateMidnight
deserializeDateMidnight
(String text, DateTimeZone zone) Deserialize date value as a midnight date in the specified time zone.static LocalDate
deserializeLocalDate
(String text) Deserialize date value from text as local date without time zone.static DateMidnight
Deserialize date value from text as midnight date in default (local) time zone.static DateTime
Deserialize date/time value from text into the local (default) time zone.static LocalTime
deserializeLocalTime
(String text) Deserialize time value from text as local time.static DateTime
Deserialize local (default zone) date/time value from text with time zone required.static DateTime
Deserialize UTC date/time value from text with time zone required.static DateMidnight
Deserialize date value from text as midnight date in UTC time zone.static DateTime
deserializeUTCDateTime
(String text) Deserialize UTC date/time value from text into the UTC time zone.static DateMidnight
Deserialize date value from text as midnight date in specified (or default) time zone.static DateTime
Deserialize date/time value from text in specified (or default) time zone.protected static DateTimeZone
Find the date/time zone for an xs:date or xs:dateTime text representation.protected static DateTime
parseDateTime
(String text, boolean full, DateTimeZone zone) Parse date/time value from text.static String
serializeLocalDate
(LocalDate date) Serialize local date value to general date text without time zone.static String
serializeUnzonedDateMidnight
(DateMidnight date) Serialize midnight date value to general date text without time zone.static String
serializeUnzonedLocalTime
(LocalTime time) Serialize local time value to general date text without time zone.static String
serializeUTCDateMidnight
(DateMidnight date) Serialize midnight date value to general date text with UTC time zone.static String
serializeUTCDateTime
(DateTime time) Serialize date/time to general dateTime text.static String
serializeUTCLocalTime
(LocalTime time) Serialize local time value to general date text with UTC time zone.static String
serializeZonedDateMidnight
(DateMidnight date) Serialize midnight date value to general date text with time zone offset.static String
serializeZonedDateTime
(DateTime time) Serialize date/time to general dateTime text.
-
Constructor Details
-
JodaConvert
public JodaConvert()
-
-
Method Details
-
deserializeLocalDate
Deserialize date value from text as local date without time zone. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DD, with optional leading sign and trailing time zone (with the time zone ignored in this case). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
serializeLocalDate
Serialize local date value to general date text without time zone. Date/time values are formatted in W3C XML Schema standard format as CCYY-MM-DD, with optional leading sign included if necessary.- Parameters:
date
- date to be converted- Returns:
- converted date text
-
deserializeDateMidnight
protected static DateMidnight deserializeDateMidnight(String text, DateTimeZone zone) throws JiBXException Deserialize date value as a midnight date in the specified time zone.- Parameters:
text
-zone
-- Returns:
- date
- Throws:
JiBXException
-
findZone
Find the date/time zone for an xs:date or xs:dateTime text representation.- Parameters:
text
- xs:date or xs:dateTime valuedflt
- default zone to be returned if no zone specified- Returns:
- zone
- Throws:
JiBXException
-
deserializeZonedDateMidnight
Deserialize date value from text as midnight date in specified (or default) time zone. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DD, with optional leading sign and trailing time zone. If the time zone indication is included a zone matching the offset is used for the date; otherwise the default time zone is used. This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
deserializeLocalDateMidnight
Deserialize date value from text as midnight date in default (local) time zone. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DD, with optional leading sign and trailing time zone (with the time zone ignored in this case). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
deserializeUTCDateMidnight
Deserialize date value from text as midnight date in UTC time zone. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DD, with optional leading sign and trailing time zone (with the time zone ignored in this case). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
serializeUnzonedDateMidnight
Serialize midnight date value to general date text without time zone. Date values are formatted in W3C XML Schema standard format as CCYY-MM-DD, with optional leading sign included if necessary.- Parameters:
date
- date to be converted- Returns:
- converted date text
-
serializeZonedDateMidnight
Serialize midnight date value to general date text with time zone offset. Date values are formatted in W3C XML Schema standard format as CCYY-MM-DD, with optional leading sign included if necessary and trailing time zone offset.- Parameters:
date
- date to be converted- Returns:
- converted date text
-
serializeUTCDateMidnight
Serialize midnight date value to general date text with UTC time zone. Date values are formatted in W3C XML Schema standard format as CCYY-MM-DDZ, with optional leading sign included if necessary.- Parameters:
date
- date to be converted- Returns:
- converted date text
-
deserializeLocalTime
Deserialize time value from text as local time. Time values are expected to match W3C XML Schema standard format as hh:mm:ss.fff, with optional trailing time zone (with the time zone ignored in this case). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
serializeUnzonedLocalTime
Serialize local time value to general date text without time zone. Time values are formatted in W3C XML Schema standard format as hh:mm:ss.fff.- Parameters:
time
- time to be converted- Returns:
- converted time text
-
serializeUTCLocalTime
Serialize local time value to general date text with UTC time zone. Time values are formatted in W3C XML Schema standard format as hh:mm:ss.fffZ, with optional leading sign included if necessary.- Parameters:
time
- time to be converted- Returns:
- converted time text
-
parseDateTime
protected static DateTime parseDateTime(String text, boolean full, DateTimeZone zone) throws JiBXException Parse date/time value from text. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign and trailing time zone (with the time zone used to convert the value to the target time zone). If the time zone is absent and not required the target time zone is assumed.- Parameters:
text
-full
- zoned time required flag (exception thrown if missing)zone
- time zone used for returned date/time- Returns:
- converted date/time
- Throws:
JiBXException
-
deserializeZonedDateTime
Deserialize date/time value from text in specified (or default) time zone. Date/time values are expected to match W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign and trailing time zone. If the time zone indication is included a zone matching the offset is used for the date; otherwise the default time zone is used. This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
deserializeUTCDateTime
Deserialize UTC date/time value from text into the UTC time zone. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign and trailing time zone (with the time zone used to convert the value to UTC, and UTC assumed if no time zone is specified). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
deserializeLocalDateTime
Deserialize date/time value from text into the local (default) time zone. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign and trailing time zone (with the time zone used to convert the value to the local time zone, and the local time zone assumed if no time zone is specified). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
deserializeStrictUTCDateTime
Deserialize UTC date/time value from text with time zone required. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign but required trailing time zone (with the time zone used to convert the value to UTC). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
deserializeStrictLocalDateTime
Deserialize local (default zone) date/time value from text with time zone required. Date values are expected to match W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign but required trailing time zone (with the time zone used to convert the value to the local time zone). This method follows standard JiBX deserializer usage requirements by accepting anull
input.- Parameters:
text
- text to be parsed (may benull
)- Returns:
- converted date, or
null
if passednull
input - Throws:
JiBXException
- on parse error
-
serializeZonedDateTime
Serialize date/time to general dateTime text. Date/time values are formatted in W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign included if necessary. Time zone information is always included in the output, with the value determined by the zone used for the date/time.- Parameters:
time
- date/time to be converted- Returns:
- converted date/time text
-
serializeUTCDateTime
Serialize date/time to general dateTime text. Date/time values are formatted in W3C XML Schema standard format as CCYY-MM-DDThh:mm:ss.fff, with optional leading sign included if necessary. Time zone information is always included in the output, as 'Z' to indicate UTC.- Parameters:
time
- date/time to be converted- Returns:
- converted date/time text
-