Package com.nimbusds.oauth2.sdk.util.date

Class DateWithTimeZoneOffset

java.lang.Object

com.nimbusds.oauth2.sdk.util.date.DateWithTimeZoneOffset

public class DateWithTimeZoneOffset
extends Object

Date with optional timezone offset. Supports basic ISO 8601 formatting and parsing.

Constructor Summary

Constructors

Constructor	Description
DateWithTimeZoneOffset(Date date)	Creates a new date in UTC, to be output with Z timezone designation.
DateWithTimeZoneOffset(Date date, int tzOffsetMinutes)	Creates a new date with timezone offset.
DateWithTimeZoneOffset(Date date, TimeZone tz)	Creates a new date with timezone offset.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Date	getDate()	Returns the date.
int	getTimeZoneOffsetMinutes()	Returns the time zone offset in minutes relative to UTC.
int	hashCode()
boolean	isUTC()	Returns true if the date is in UTC.
static DateWithTimeZoneOffset	parseISO8601String(String s)	Parses an ISO 8601 representation in YYYY-MM-DDThh:mm:ss±hh:mm format.
String	toISO8601String()	Returns an ISO 8601 representation in YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss±hh:mm format
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DateWithTimeZoneOffset

public DateWithTimeZoneOffset(Date date)

Creates a new date in UTC, to be output with Z timezone designation.

Parameters:

date - The date. Must not be null.

DateWithTimeZoneOffset

public DateWithTimeZoneOffset(Date date,
                              int tzOffsetMinutes)

Creates a new date with timezone offset.

Parameters:

date - The date. Must not be null.

tzOffsetMinutes - The time zone offset in minutes relative to UTC, zero if none. Must be less than +/- 12 x 60.

DateWithTimeZoneOffset

public DateWithTimeZoneOffset(Date date,
                              TimeZone tz)

Creates a new date with timezone offset.

Parameters:

date - The date. Must not be null.

tz - The time zone to determine the time zone offset.

Method Detail

getDate

public Date getDate()

Returns the date.

Returns:

The date.

isUTC

public boolean isUTC()

Returns true if the date is in UTC.

Returns:

true if the date is in UTC, else the time zone offset applies.

getTimeZoneOffsetMinutes

public int getTimeZoneOffsetMinutes()

Returns the time zone offset in minutes relative to UTC.

Returns:

The time zone offset in minutes relative to UTC, zero if none.

toISO8601String

public String toISO8601String()

Returns an ISO 8601 representation in YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss±hh:mm format

Example: 2019-11-01T18:19:43+03:00

Returns:

The ISO 8601 representation.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

parseISO8601String

public static DateWithTimeZoneOffset parseISO8601String(String s)
                                                 throws ParseException

Parses an ISO 8601 representation in YYYY-MM-DDThh:mm:ss±hh:mm format.

Example: 2019-11-01T18:19:43+03:00

Parameters:

s - The string to parse.

Returns:

The date with timezone offset.

Throws:

ParseException - If parsing failed.