com.devexperts.util

Class TimeFormat

java.lang.Object

com.devexperts.util.TimeFormat

public class TimeFormat
extends Object

Utility class for parsing and formatting dates and times in ISO-compatible format.

Field Summary

Fields

Modifier and Type	Field and Description
static TimeFormat	DEFAULT An instance of TimeFormat that corresponds to default timezone as returned by TimeZone.getDefault() method.
static TimeFormat	GMT An instance of TimeFormat that corresponds to GMT timezone as returned by TimeZone.getTimeZone("GMT").

Method Summary

Modifier and Type	Method and Description
TimeFormat	asFullIso() Returns TimeFormat instance that produces full ISO8610 string of "yyyy-MM-dd'T'HH:mm:ss.SSSX".
String	format(Date time) Converts Date object into string according to the format like yyyyMMdd-HHmmss.
String	format(long time) This is a shortcut for format(new Date(time)).
static TimeFormat	getInstance(TimeZone timezone) Returns TimeFormat instance for a specified timezone.
TimeZone	getTimeZone() Returns timezone of this TimeFormat instance.
Date	parse(String value) Reads Date from String.
static void	setDefaultTimeZone(TimeZone timezone) Deprecated. For internal tests only. May be removed in future QD releases.
TimeFormat	withMillis() Returns TimeFormat instance that also includes milliseconds into string when using format method.
TimeFormat	withTimeZone() Returns TimeFormat instance that also includes timezone into string when using format method.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final TimeFormat DEFAULT

An instance of TimeFormat that corresponds to default timezone as returned by TimeZone.getDefault() method.

GMT

public static final TimeFormat GMT

An instance of TimeFormat that corresponds to GMT timezone as returned by TimeZone.getTimeZone("GMT").

Method Detail

getInstance

public static TimeFormat getInstance(TimeZone timezone)

Returns TimeFormat instance for a specified timezone.

Parameters:

timezone - timezone for TimeFormat.

Throws:

NullPointerException - if timezone is null.

setDefaultTimeZone

@Deprecated
public static void setDefaultTimeZone(TimeZone timezone)

Deprecated. For internal tests only. May be removed in future QD releases.

Changes time zone for DEFAULT instance on the current and new threads. This method is not thread-safe. It is designed for use in unit-tests only. Do not use this method in production code. It prints warning to the log when used.

withTimeZone

public TimeFormat withTimeZone()

Returns TimeFormat instance that also includes timezone into string when using format method.

withMillis

public TimeFormat withMillis()

Returns TimeFormat instance that also includes milliseconds into string when using format method.

asFullIso

public TimeFormat asFullIso()

Returns TimeFormat instance that produces full ISO8610 string of "yyyy-MM-dd'T'HH:mm:ss.SSSX".

parse

public Date parse(String value)
           throws InvalidFormatException,
                  NullPointerException

Reads Date from String. This method is designed to understand ISO 8601 formatted date and time. It accepts the following formats:

• 0 is parsed as zero time.
• '-'<time-period> it is parsed as <current time> - <time-period>. TimePeriod here is parsed by TimePeriod.valueOf(String).
• <long-value-in-milliseconds> It should be positive and have at least 9 digits (otherwise it could not be distinguished from date in format 'yyyymmdd'). Each date since 1970-01-03 can be represented in this form.
• <date>[('T'|'t'|'-'|' ')<time>][<timezone>] If time is missing it is supposed to be '00:00:00'.
• ['T'|'t']<time>[<timezone>] In this case current date is used.

Here

• <date> is one of
  • yyyy-MM-dd
  • yyyyMMdd
• <time> is one of
  • HH:mm:ss[.sss]
  • HHmmss[.sss]
  • HH:mm
  • HHmm
  • HH
• <timezone> is one of
  • [+-]HH:mm
  • [+-]HHmm
  • [+-]HH
  • Z for UTC.
  • or any timezone that can be parsed by SimpleDateFormat.

Parameters:

value - String value to parse.

Returns:

Date parsed from value.

Throws:

InvalidFormatException - if value has wrong format.

NullPointerException - if value == null.

See Also:

SimpleDateFormat

format

public String format(Date time)
              throws NullPointerException

Converts Date object into string according to the format like yyyyMMdd-HHmmss. When withTimeZone() was used to acquire this TimeFormat instance, then time zone is also included and formatted according to RFC 822 format (for example "+0300"). When withMillis() was used to acquire this TimeFormat instance, the milliseconds are also included as .sss.

When time.getTime() == 0 this method returns string "0".

When time yyyyMMdd representation is outside [00010101, 99991231] range this method returns string representing time.getTime() long value.

Parameters:

time - date and time to format.

Returns:

string representation of data and time.

Throws:

NullPointerException - if time is null.

format

public String format(long time)

This is a shortcut for format(new Date(time)).

getTimeZone

public TimeZone getTimeZone()

Returns timezone of this TimeFormat instance.

Returns:

timezone of this TimeFormat instance.