com.aspc.remote.util.misc

Class TimeUtil

java.lang.Object

com.aspc.remote.util.misc.TimeUtil

public final class TimeUtil
extends java.lang.Object

TimeUtil handles timestamps
THREAD MODE: MULTI-THREADED

Since:

May 17, 2001

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENT_TIMESTAMP the current timestamp
static java.lang.String	DEFAULT_DATE_FORMAT
static java.lang.String	DEFAULT_TIME_FORMAT
static java.lang.String	END_OF_DAY
static java.lang.String	MARKET_CLOSE
static java.lang.String	REST_TIME_FORMAT
static java.lang.String	START_OF_DAY
static java.lang.String	W3C_DATETIME W3C Datetime Format (also known as ISO 8601).

Method Summary

Modifier and Type	Method and Description
static java.util.Date	addDurationToDate(java.util.Date startDt, java.lang.String durationString, java.util.TimeZone tz)
static long	convertDurationToMs(java.lang.String durationString)
static java.lang.String	format(java.lang.String pattern, java.util.Date date, java.util.TimeZone tz) Format a date to the passed pattern.
static java.lang.String	getDiff(java.util.Date start) Returns the difference in the start dates and now as xx Hrs xx Min xx Secs.
static java.lang.String	getDiff(java.util.Date start, java.util.Date end) Returns the difference in the two dates as xx Hrs xx Min xx Secs.
static java.lang.String	getDiff(java.util.Date start, java.util.Date end, TimePars pars) Returns the difference in the two dates as xx Hrs xx Min xx Secs.
static java.lang.String	getDiff(long start) Returns the difference in the two dates as xx Hrs xx Min xx Secs.
static java.lang.String	getDiff(long start, long end) Returns the difference in the two dates as xx Hrs xx Min xx Secs.
static java.lang.String	getDiff(long start, long end, TimePars pars) Returns the difference in the two dates as xx Hrs xx Min xx Secs.
static java.util.GregorianCalendar	getGC(java.util.TimeZone timeZone)
static java.lang.String	getStdFormat(java.util.Date date, java.util.TimeZone timeZone) return dateTime in d MMM yyyy HH:mm:ss
static java.util.Date	parse(java.lang.String pattern, java.lang.String source, java.util.TimeZone tz) Parse a date from the passed pattern.
static java.util.Date	parseLocalUserTime(java.lang.String dateString, java.util.TimeZone timeZone, java.lang.String timeOfDay)
static java.lang.String	parseUserDuration(java.lang.String durationString)
static java.util.Date	parseUserTime(java.lang.String userDateString, java.util.TimeZone userTimeZone)
static java.util.Date	parseUserTime(java.lang.String userDateString, java.util.TimeZone userTimeZone, boolean defaultToEndOfDay)
static java.util.Date	parseUserTime(java.lang.String userDateString, java.util.TimeZone userTimeZone, boolean defaultToEndOfDay, boolean parseMilliseconds)
static java.util.Date	parseW3CDatetime(java.lang.String w3cDatetime)
static java.util.Date	subtractDurationFromDate(java.util.Date startDt, java.lang.String durationString, java.util.TimeZone tz)

Methods inherited from class java.lang.Object

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

Field Detail

W3C_DATETIME

public static final java.lang.String W3C_DATETIME

W3C Datetime Format (also known as ISO 8601). https://en.wikipedia.org/wiki/ISO_8601

See Also:

Constant Field Values

REST_TIME_FORMAT

public static final java.lang.String REST_TIME_FORMAT

See Also:

Constant Field Values

END_OF_DAY

public static final java.lang.String END_OF_DAY

See Also:

Constant Field Values

CURRENT_TIMESTAMP

public static final java.lang.String CURRENT_TIMESTAMP

the current timestamp

See Also:

Constant Field Values

START_OF_DAY

public static final java.lang.String START_OF_DAY

See Also:

Constant Field Values

MARKET_CLOSE

public static final java.lang.String MARKET_CLOSE

See Also:

Constant Field Values

DEFAULT_TIME_FORMAT

public static final java.lang.String DEFAULT_TIME_FORMAT

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final java.lang.String DEFAULT_DATE_FORMAT

See Also:

Constant Field Values

Method Detail

parseW3CDatetime

public static java.util.Date parseW3CDatetime(@Nonnull
                                              java.lang.String w3cDatetime)
                                       throws java.text.ParseException

Throws:

java.text.ParseException

getGC

@CheckReturnValue
 @Nonnull
public static java.util.GregorianCalendar getGC(@Nullable
                                                                            java.util.TimeZone timeZone)

getDiff

@CheckReturnValue
 @Nonnull
public static java.lang.String getDiff(@Nonnull
                                                                   java.util.Date start)

Returns the difference in the start dates and now as xx Hrs xx Min xx Secs.

Parameters:

start - The start time

Returns:

A user readable time difference

getDiff

@CheckReturnValue
 @Nonnull
public static java.lang.String getDiff(@Nonnull
                                                                   java.util.Date start,
                                                                   @Nullable
                                                                   java.util.Date end)

Returns the difference in the two dates as xx Hrs xx Min xx Secs.

Parameters:

start - The start time

end - The end time

Returns:

A user readable time difference

getDiff

@CheckReturnValue
 @Nonnull
public static java.lang.String getDiff(java.util.Date start,
                                                                   java.util.Date end,
                                                                   TimePars pars)

Returns the difference in the two dates as xx Hrs xx Min xx Secs.

Parameters:

start - The start time

end - The end time

pars - the parameters

Returns:

A user readable time difference

getDiff

@CheckReturnValue
 @Nonnull
public static java.lang.String getDiff(long start)

Returns the difference in the two dates as xx Hrs xx Min xx Secs.

Parameters:

start - The start time

Returns:

A user readable time difference

getDiff

@CheckReturnValue
 @Nonnull
public static java.lang.String getDiff(long start,
                                                                   long end)

Returns the difference in the two dates as xx Hrs xx Min xx Secs.

Parameters:

start - The start time

end - The end time

Returns:

A user readable time difference

getDiff

@CheckReturnValue
 @Nonnull
public static java.lang.String getDiff(long start,
                                                                   long end,
                                                                   TimePars pars)

Returns the difference in the two dates as xx Hrs xx Min xx Secs.

Parameters:

start - The start time

end - The end time

pars - the parameters

Returns:

A user readable time difference

parseUserTime

@CheckReturnValue
 @Nonnull
public static java.util.Date parseUserTime(@Nonnull
                                                                       java.lang.String userDateString,
                                                                       @Nullable
                                                                       java.util.TimeZone userTimeZone,
                                                                       boolean defaultToEndOfDay,
                                                                       boolean parseMilliseconds)
                                                                throws InvalidDataException

Parameters:

userDateString -

userTimeZone -

defaultToEndOfDay -

parseMilliseconds - default true, dateString can contain milliseconds

Returns:

the value

Throws:

InvalidDataException

parseUserTime

@CheckReturnValue
 @Nonnull
public static java.util.Date parseUserTime(@Nonnull
                                                                       java.lang.String userDateString,
                                                                       @Nullable
                                                                       java.util.TimeZone userTimeZone,
                                                                       boolean defaultToEndOfDay)
                                                                throws InvalidDataException

Parameters:

userDateString -

userTimeZone -

defaultToEndOfDay -

Returns:

the value

Throws:

InvalidDataException

parseUserDuration

@CheckReturnValue
 @Nullable
public static java.lang.String parseUserDuration(java.lang.String durationString)
                                                                       throws InvalidDataException

Parameters:

durationString -

Returns:

the value

Throws:

InvalidDataException

convertDurationToMs

@CheckReturnValue
public static long convertDurationToMs(@Nullable
                                                         java.lang.String durationString)
                                                  throws InvalidDataException

Parameters:

durationString -

Returns:

the value

Throws:

InvalidDataException

addDurationToDate

@CheckReturnValue
 @Nullable
public static java.util.Date addDurationToDate(java.util.Date startDt,
                                                                            java.lang.String durationString,
                                                                            java.util.TimeZone tz)
                                                                     throws InvalidDataException

Parameters:

startDt -

durationString -

tz - timezone

Returns:

the value

Throws:

InvalidDataException

subtractDurationFromDate

@CheckReturnValue
 @Nullable
public static java.util.Date subtractDurationFromDate(java.util.Date startDt,
                                                                                   java.lang.String durationString,
                                                                                   java.util.TimeZone tz)
                                                                            throws InvalidDataException

Parameters:

startDt -

durationString -

tz - timezone

Returns:

the value

Throws:

InvalidDataException

parse

@CheckReturnValue
 @Nonnull
public static java.util.Date parse(@Nonnull
                                                               java.lang.String pattern,
                                                               @Nonnull
                                                               java.lang.String source,
                                                               @Nullable
                                                               java.util.TimeZone tz)
                                                        throws java.text.ParseException

Parse a date from the passed pattern.
We use a thread local to store a HashMap of simple date formatters by the pattern string. This allows us to have the performance benefit of having a static formatter without the multi-thread issues associated with static formatters.

Parameters:

pattern - The date pattern to use

source - the textual version of the date

tz - The timezone to use ( default to GMT)

Returns:

The date object parsed

Throws:

java.text.ParseException - if can't parse the source

parseLocalUserTime

@CheckReturnValue
 @Nonnull
public static java.util.Date parseLocalUserTime(java.lang.String dateString,
                                                                            java.util.TimeZone timeZone,
                                                                            java.lang.String timeOfDay)
                                                                     throws InvalidDataException

Parameters:

dateString -

timeZone -

timeOfDay -

Returns:

the value

Throws:

InvalidDataException

getStdFormat

@CheckReturnValue
 @Nonnull
public static java.lang.String getStdFormat(java.util.Date date,
                                                                        java.util.TimeZone timeZone)

return dateTime in d MMM yyyy HH:mm:ss

Parameters:

date -

timeZone -

Returns:

the value

format

@CheckReturnValue
 @Nonnull
public static java.lang.String format(@Nonnull
                                                                  java.lang.String pattern,
                                                                  @Nullable
                                                                  java.util.Date date,
                                                                  @Nullable
                                                                  java.util.TimeZone tz)

Format a date to the passed pattern.
We use a thread local to store a HashMap of simple date formatters by the pattern string. This allows us to have the performance benefit of having a static formatter without the multi-thread issues associated with static formatters.

Parameters:

pattern - The date pattern to use

date - the date to be formatted ( default to NOW)

tz - The timezone to use ( default to GMT)

Returns:

The formatted date string

parseUserTime

@CheckReturnValue
 @Nonnull
public static java.util.Date parseUserTime(@Nonnull
                                                                       java.lang.String userDateString,
                                                                       @Nullable
                                                                       java.util.TimeZone userTimeZone)
                                                                throws InvalidDataException

Parameters:

userDateString -

userTimeZone -

Returns:

the value

Throws:

InvalidDataException