Package com.helger.datetime.util

Class PDTXMLConverter

java.lang.Object

com.helger.datetime.util.PDTXMLConverter

@Immutable
public final class PDTXMLConverter
extends Object

Utility class for XML date/time data type handling.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
static XMLGregorianCalendar	createNewCalendar()
static GregorianCalendar	getCalendar(Date aDate)	Get the passed date as GregorianCalendar using the default time zone.
static GregorianCalendar	getCalendarDefaultTimeZone(long nMillis)	Get the passed milliseconds as GregorianCalendar.
static GregorianCalendar	getCalendarUTC(long nMillis)	Get the passed milliseconds as GregorianCalendar.
static DatatypeFactory	getDatatypeFactory()
static Date	getDate(XMLGregorianCalendar aCal)	Get the passed XMLGregorianCalendar as Date.
static GregorianCalendar	getGregorianCalendar(XMLGregorianCalendar aCal)	Convert the passed XMLGregorianCalendar to a GregorianCalendar.
static LocalDate	getLocalDate(XMLGregorianCalendar aCal)	Get the passed XMLGregorianCalendar as LocalDate.
static LocalDateTime	getLocalDateTime(XMLGregorianCalendar aCal)	Get the passed XMLGregorianCalendar as LocalDateTime.
static LocalTime	getLocalTime(XMLGregorianCalendar aCal)	Get the passed XMLGregorianCalendar as LocalTime.
static long	getMillis(XMLGregorianCalendar aCal)	Get the passed XMLGregorianCalendar as milliseconds.
static int	getTimezoneOffsetInMinutes(int nOffsetInMillis)	Convert milliseconds to minutes.
static int	getTimezoneOffsetInMinutes(Calendar aCalendar)	Get the time zone offset to UTC of the passed calendar in minutes to be used in XMLGregorianCalendar.
static XMLGregorianCalendar	getXMLCalendar(long nMillis)	Get the passed milliseconds as XMLGregorianCalendar.
static XMLGregorianCalendar	getXMLCalendar(LocalDateTime aBase)	Get the passed object as XMLGregorianCalendar with date and time.
static XMLGregorianCalendar	getXMLCalendar(ZonedDateTime aBase)	Get the passed object as XMLGregorianCalendar with date and time.
static XMLGregorianCalendar	getXMLCalendar(Date aDate)	Get the passed Date as XMLGregorianCalendar.
static XMLGregorianCalendar	getXMLCalendar(GregorianCalendar aCal)	Get the passed GregorianCalendar as XMLGregorianCalendar.
static XMLGregorianCalendar	getXMLCalendar(XMLGregorianCalendar aDate, XMLGregorianCalendar aTime)	Create a new XMLGregorianCalendar using separate objects for date and time.
static XMLGregorianCalendar	getXMLCalendarDate(int nYear, int nMonth, int nDay)	Create a Java representation of XML Schema builtin datatype date or g*.
static XMLGregorianCalendar	getXMLCalendarDate(int nYear, int nMonth, int nDay, int nTimezone)	Create a Java representation of XML Schema builtin datatype date or g*.
static XMLGregorianCalendar	getXMLCalendarDate(LocalDate aBase)	Get the passed object as XMLGregorianCalendar date (without a time).
static XMLGregorianCalendar	getXMLCalendarDate(LocalDate aBase, int nTimezoneOffsetInMinutes)	Get the passed object as XMLGregorianCalendar date (without a time).
static XMLGregorianCalendar	getXMLCalendarDate(Date aBase)	Get the passed object as XMLGregorianCalendar date (without a time).
static XMLGregorianCalendar	getXMLCalendarDate(GregorianCalendar aBase)	Get the passed object as XMLGregorianCalendar date (without a time).
static XMLGregorianCalendar	getXMLCalendarDate(XMLGregorianCalendar aBase)	Get the passed object as XMLGregorianCalendar date (without a time).
static XMLGregorianCalendar	getXMLCalendarDateNow()	Get the current date as XMLGregorianCalendar.
static XMLGregorianCalendar	getXMLCalendarNow()	Get the current date and time as XMLGregorianCalendar in the default time zone.
static XMLGregorianCalendar	getXMLCalendarNowUTC()	Get the current date and time as XMLGregorianCalendar in UTC.
static XMLGregorianCalendar	getXMLCalendarTime(int nHour, int nMinute, int nSecond, int nMilliSecond)	Create a Java representation of XML Schema builtin datatype date or g*.
static XMLGregorianCalendar	getXMLCalendarTime(int nHour, int nMinute, int nSecond, int nMilliSecond, int nTimezone)	Create a Java representation of XML Schema builtin datatype date or g*.
static XMLGregorianCalendar	getXMLCalendarTime(LocalTime aBase)	Get the passed object as XMLGregorianCalendar time (without a date).
static XMLGregorianCalendar	getXMLCalendarTime(Date aBase)	Get the passed object as XMLGregorianCalendar time (without a date).
static XMLGregorianCalendar	getXMLCalendarTime(GregorianCalendar aBase)	Get the passed object as XMLGregorianCalendar time (without a date).
static XMLGregorianCalendar	getXMLCalendarTime(XMLGregorianCalendar aBase)	Get the passed object as XMLGregorianCalendar time (without a date).
static XMLGregorianCalendar	getXMLCalendarTimeNow()	Get the current time as XMLGregorianCalendar.
static XMLGregorianCalendar	getXMLCalendarUTC(long nMillis)	Get the passed milliseconds as XMLGregorianCalendar.
static ZonedDateTime	getZonedDateTime(XMLGregorianCalendar aCal)	Get the passed XMLGregorianCalendar as ZonedDateTime.

Methods inherited from class java.lang.Object

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

Method Detail

getDatatypeFactory

@Nonnull
public static DatatypeFactory getDatatypeFactory()

Returns:

The global DatatypeFactory used internally in this class.

getTimezoneOffsetInMinutes

public static int getTimezoneOffsetInMinutes(int nOffsetInMillis)

Convert milliseconds to minutes.

Parameters:

nOffsetInMillis - The offset in milliseconds to use. May not be null.

Returns:

0 for no offset to UTC, the minutes otherwise. Usually in 60minutes steps :)

getTimezoneOffsetInMinutes

public static int getTimezoneOffsetInMinutes(@Nonnull
                                             Calendar aCalendar)

Get the time zone offset to UTC of the passed calendar in minutes to be used in XMLGregorianCalendar.

Parameters:

aCalendar - The calendar to use. May not be null.

Returns:

0 for no offset to UTC, the minutes otherwise. Usually in 60minutes steps :)

getCalendar

@Nonnull
public static GregorianCalendar getCalendar(@Nonnull
                                            Date aDate)

Get the passed date as GregorianCalendar using the default time zone.

Parameters:

aDate - The source date. May be null.

Returns:

Never null.

getCalendarDefaultTimeZone

@Nonnull
public static GregorianCalendar getCalendarDefaultTimeZone(long nMillis)

Get the passed milliseconds as GregorianCalendar.

Parameters:

nMillis - Milliseconds since 1.1.1970

Returns:

Never null.

Since:

9.1.8

getCalendarUTC

@Nonnull
public static GregorianCalendar getCalendarUTC(long nMillis)

Get the passed milliseconds as GregorianCalendar.

Parameters:

nMillis - Milliseconds since 1.1.1970

Returns:

Never null.

Since:

9.1.8

createNewCalendar

@Nonnull
public static XMLGregorianCalendar createNewCalendar()

Returns:

A new XML calendar instance, with all fields uninitialized. Never null.

getXMLCalendarDateNow

@Nonnull
public static XMLGregorianCalendar getXMLCalendarDateNow()

Get the current date as XMLGregorianCalendar.

Returns:

Never null.

getXMLCalendarDate

@Nullable
public static XMLGregorianCalendar getXMLCalendarDate(@Nullable
                                                      LocalDate aBase)

Get the passed object as XMLGregorianCalendar date (without a time).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarDate

@Nullable
public static XMLGregorianCalendar getXMLCalendarDate(@Nullable
                                                      LocalDate aBase,
                                                      int nTimezoneOffsetInMinutes)

Get the passed object as XMLGregorianCalendar date (without a time).

Parameters:

aBase - The source object. May be null.

nTimezoneOffsetInMinutes - Timezone offset in minutes. Use DatatypeConstants.FIELD_UNDEFINED if none is to be used.

Returns:

null if the parameter is null.

Since:

9.3.5

getXMLCalendarDate

@Nullable
public static XMLGregorianCalendar getXMLCalendarDate(@Nullable
                                                      Date aBase)

Get the passed object as XMLGregorianCalendar date (without a time).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarDate

@Nullable
public static XMLGregorianCalendar getXMLCalendarDate(@Nullable
                                                      GregorianCalendar aBase)

Get the passed object as XMLGregorianCalendar date (without a time).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarDate

@Nullable
public static XMLGregorianCalendar getXMLCalendarDate(@Nullable
                                                      XMLGregorianCalendar aBase)

Get the passed object as XMLGregorianCalendar date (without a time).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarDate

@Nonnull
public static XMLGregorianCalendar getXMLCalendarDate(int nYear,
                                                      int nMonth,
                                                      int nDay)

Create a Java representation of XML Schema builtin datatype date or g*.

For example, an instance of gYear can be created invoking this factory with month and day parameters set to DatatypeConstants.FIELD_UNDEFINED.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Parameters:

nYear - Year to be created.

nMonth - Month to be created.

nDay - Day to be created.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

getXMLCalendarDate

@Nonnull
public static XMLGregorianCalendar getXMLCalendarDate(int nYear,
                                                      int nMonth,
                                                      int nDay,
                                                      int nTimezone)

Create a Java representation of XML Schema builtin datatype date or g*.

For example, an instance of gYear can be created invoking this factory with month and day parameters set to DatatypeConstants.FIELD_UNDEFINED.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Parameters:

nYear - Year to be created.

nMonth - Month to be created.

nDay - Day to be created.

nTimezone - Offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

getXMLCalendarTimeNow

@Nonnull
public static XMLGregorianCalendar getXMLCalendarTimeNow()

Get the current time as XMLGregorianCalendar.

Returns:

Never null.

getXMLCalendarTime

@Nullable
public static XMLGregorianCalendar getXMLCalendarTime(@Nullable
                                                      LocalTime aBase)

Get the passed object as XMLGregorianCalendar time (without a date).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarTime

@Nullable
public static XMLGregorianCalendar getXMLCalendarTime(@Nullable
                                                      Date aBase)

Get the passed object as XMLGregorianCalendar time (without a date).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarTime

@Nullable
public static XMLGregorianCalendar getXMLCalendarTime(@Nullable
                                                      GregorianCalendar aBase)

Get the passed object as XMLGregorianCalendar time (without a date).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarTime

@Nullable
public static XMLGregorianCalendar getXMLCalendarTime(@Nullable
                                                      XMLGregorianCalendar aBase)

Get the passed object as XMLGregorianCalendar time (without a date).

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendarTime

@Nonnull
public static XMLGregorianCalendar getXMLCalendarTime(int nHour,
                                                      int nMinute,
                                                      int nSecond,
                                                      int nMilliSecond)

Create a Java representation of XML Schema builtin datatype date or g*.

For example, an instance of gYear can be created invoking this factory with month and day parameters set to DatatypeConstants.FIELD_UNDEFINED.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Parameters:

nHour - Hour to be created.

nMinute - Minute to be created.

nSecond - Second to be created.

nMilliSecond - Milli second to be created.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

getXMLCalendarTime

@Nonnull
public static XMLGregorianCalendar getXMLCalendarTime(int nHour,
                                                      int nMinute,
                                                      int nSecond,
                                                      int nMilliSecond,
                                                      int nTimezone)

Create a Java representation of XML Schema builtin datatype date or g*.

For example, an instance of gYear can be created invoking this factory with month and day parameters set to DatatypeConstants.FIELD_UNDEFINED.

A DatatypeConstants.FIELD_UNDEFINED value indicates that field is not set.

Parameters:

nHour - Hour to be created.

nMinute - Minute to be created.

nSecond - Second to be created.

nMilliSecond - Milli second to be created.

nTimezone - Offset in minutes. DatatypeConstants.FIELD_UNDEFINED indicates optional field is not set.

Returns:

XMLGregorianCalendar created from parameter values.

Throws:

IllegalArgumentException - If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in XMLGregorianCalendar or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by XMLGregorianCalendar.isValid().

See Also:

DatatypeConstants.FIELD_UNDEFINED

getXMLCalendarNow

@Nonnull
public static XMLGregorianCalendar getXMLCalendarNow()

Get the current date and time as XMLGregorianCalendar in the default time zone.

Returns:

Never null.

getXMLCalendarNowUTC

@Nonnull
public static XMLGregorianCalendar getXMLCalendarNowUTC()

Get the current date and time as XMLGregorianCalendar in UTC.

Returns:

Never null.

getXMLCalendar

@Nullable
public static XMLGregorianCalendar getXMLCalendar(@Nullable
                                                  LocalDateTime aBase)

Get the passed object as XMLGregorianCalendar with date and time.

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendar

@Nullable
public static XMLGregorianCalendar getXMLCalendar(@Nullable
                                                  ZonedDateTime aBase)

Get the passed object as XMLGregorianCalendar with date and time.

Parameters:

aBase - The source object. May be null.

Returns:

null if the parameter is null.

getXMLCalendar

@Nullable
public static XMLGregorianCalendar getXMLCalendar(@Nullable
                                                  GregorianCalendar aCal)

Get the passed GregorianCalendar as XMLGregorianCalendar.

Parameters:

aCal - Source calendar. May be null.

Returns:

null if the passed calendar is null.

getXMLCalendar

@Nullable
public static XMLGregorianCalendar getXMLCalendar(@Nullable
                                                  XMLGregorianCalendar aDate,
                                                  @Nullable
                                                  XMLGregorianCalendar aTime)

Create a new XMLGregorianCalendar using separate objects for date and time.

Parameters:

aDate - Source date. May be null.

aTime - Source time. May be null.

Returns:

null if the passed date and time are null .

getXMLCalendar

@Nonnull
public static XMLGregorianCalendar getXMLCalendar(long nMillis)

Get the passed milliseconds as XMLGregorianCalendar.

Parameters:

nMillis - Milliseconds since 1.1.1970

Returns:

Never null.

getXMLCalendarUTC

@Nonnull
public static XMLGregorianCalendar getXMLCalendarUTC(long nMillis)

Get the passed milliseconds as XMLGregorianCalendar.

Parameters:

nMillis - Milliseconds since 1.1.1970

Returns:

Never null.

Since:

9.1.8

getXMLCalendar

@Nullable
public static XMLGregorianCalendar getXMLCalendar(@Nullable
                                                  Date aDate)

Get the passed Date as XMLGregorianCalendar.

Parameters:

aDate - Source date. May be null.

Returns:

null if the passed date is null.

getGregorianCalendar

@Nullable
public static GregorianCalendar getGregorianCalendar(@Nullable
                                                     XMLGregorianCalendar aCal)

Convert the passed XMLGregorianCalendar to a GregorianCalendar.

Parameters:

aCal - Source calendar. May be null.

Returns:

null if the parameter is null.

getLocalDate

@Nullable
public static LocalDate getLocalDate(@Nullable
                                     XMLGregorianCalendar aCal)

Get the passed XMLGregorianCalendar as LocalDate.

Parameters:

aCal - The source XMLGregorianCalendar. May be null.

Returns:

null if the parameter is null.

getLocalTime

@Nullable
public static LocalTime getLocalTime(@Nullable
                                     XMLGregorianCalendar aCal)

Get the passed XMLGregorianCalendar as LocalTime.

Parameters:

aCal - The source XMLGregorianCalendar. May be null.

Returns:

null if the parameter is null.

getLocalDateTime

@Nullable
public static LocalDateTime getLocalDateTime(@Nullable
                                             XMLGregorianCalendar aCal)

Get the passed XMLGregorianCalendar as LocalDateTime.

Parameters:

aCal - The source XMLGregorianCalendar. May be null.

Returns:

null if the parameter is null.

getZonedDateTime

@Nullable
public static ZonedDateTime getZonedDateTime(@Nullable
                                             XMLGregorianCalendar aCal)

Get the passed XMLGregorianCalendar as ZonedDateTime.

Parameters:

aCal - The source XMLGregorianCalendar. May be null.

Returns:

null if the parameter is null.

getDate

@Nullable
public static Date getDate(@Nullable
                           XMLGregorianCalendar aCal)

Get the passed XMLGregorianCalendar as Date.

Parameters:

aCal - The source XMLGregorianCalendar. May be null.

Returns:

null if the parameter is null.

getMillis

@CheckForSigned
public static long getMillis(@Nullable
                             XMLGregorianCalendar aCal)

Get the passed XMLGregorianCalendar as milliseconds.

Parameters:

aCal - The source XMLGregorianCalendar. May be null.

Returns:

CGlobal.ILLEGAL_ULONG if the parameter is null.