Package org.webpki.util

Class ISODateTime

java.lang.Object

org.webpki.util.ISODateTime

public class ISODateTime
extends Object

Encodes/decodes ISO dateTime objects.

Always: yyyy-mm-ddThh:mm:ss
Optionally: a '.' followed by 1-9 digits holding fractions of a second
Finally: 'Z' for UTC or an UTC time-zone difference expressed as ±hh:mm.

Sample values:

ISO dateTime	Description
2022-12-24T05:45:23-08:00	Local dateTime without sub-seconds.
2022-12-24T13:45:23Z	The same dateTime as the previous, expressed as UTC.
2022-12-24T05:45:23.856-08:00	Local dateTime with sub-seconds.
2022-12-24T13:45:23.856Z	The same dateTime as the previous, expressed as UTC.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ISODateTime.DatePatterns	Enumeration of ISO time features.

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumSet<ISODateTime.DatePatterns>	COMPLETE	For decode(String, EnumSet<DatePatterns>) only: accept all valid forms.
static final EnumSet<ISODateTime.DatePatterns>	LOCAL_NO_SUBSECONDS
static final EnumSet<ISODateTime.DatePatterns>	UTC_NO_SUBSECONDS

Method Summary

Modifier and Type	Method	Description
static GregorianCalendar	decode(String dateTime, EnumSet<ISODateTime.DatePatterns> constraints)	Decodes an ISO compliant dateTime string.
static String	encode(GregorianCalendar dateTime, EnumSet<ISODateTime.DatePatterns> format)	Encodes an ISO compliant dateTime string.

Methods inherited from class java.lang.Object

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

Field Details

UTC_NO_SUBSECONDS

public static final EnumSet<ISODateTime.DatePatterns> UTC_NO_SUBSECONDS

LOCAL_NO_SUBSECONDS

public static final EnumSet<ISODateTime.DatePatterns> LOCAL_NO_SUBSECONDS

COMPLETE

public static final EnumSet<ISODateTime.DatePatterns> COMPLETE

For decode(String, EnumSet<DatePatterns>) only: accept all valid forms.

Method Details

decode

public static GregorianCalendar decode(String dateTime,
 EnumSet<ISODateTime.DatePatterns> constraints)

Decodes an ISO compliant dateTime string.

Parameters:

dateTime - ISO formatted dateTime string

constraints - Permitted input format variants

Returns:

GregorianCalendar

Throws:

IllegalArgumentException

encode

public static String encode(GregorianCalendar dateTime,
 EnumSet<ISODateTime.DatePatterns> format)

Encodes an ISO compliant dateTime string.

If ISODateTime.DatePatterns.MILLISECONDS is defined, milliseconds (.nnn] are included in the output, else only seconds are used.

If ISODateTime.DatePatterns.UTC is defined, UTC format is applied, else local time format is assumed.

Parameters:

dateTime - The date/time object

format - Output format

Returns:

ISO formatted dateTime string