org.transitime.utils

Class Time

java.lang.Object

org.transitime.utils.Time

public class Time
extends java.lang.Object

Contains convenience methods for dealing with time issues.

Note: To use the proper timezone should set TimeZone.setDefault(TimeZone.getTimeZone(timeZoneStr)); before this class is initialized. Otherwise the SimpleDateFormat objects will wrongly use the system default timezone.

Author:

SkiBu Smith

Field Summary

Fields

Modifier and Type	Field and Description
static long	DAY_IN_MSECS
static int	DAY_IN_SECS
static int	HOUR_IN_MINS
static long	HOUR_IN_MSECS
static int	HOUR_IN_SECS
static int	MIN_IN_MSECS
static int	MIN_IN_SECS
static int	MIN_PER_HOUR
static long	MS_PER_DAY
static long	MS_PER_HOUR
static int	MS_PER_MIN
static int	MS_PER_SEC
static long	MS_PER_WEEK
static long	MS_PER_YEAR
static long	MSEC_IN_NSECS
static long	NSEC_PER_MSEC
static int	SEC_IN_MSECS
static int	SEC_PER_DAY
static int	SEC_PER_HOUR
static int	SEC_PER_MIN
static long	WEEK_IN_MSECS
static long	YEAR_IN_MSECS

Constructor Summary

Constructors

Constructor and Description
Time(DbConfig dbConfig) Methods
Time(java.lang.String timeZoneStr) Creates a Time object for the specified timezone.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	dateStr(java.util.Date epochTime) Returns date in format "MM-dd-yyyy"
static java.lang.String	dateStr(long epochTime) Returns date in format "MM-dd-yyyy"
static java.lang.String	dateTimeStr(java.util.Date epochTime) Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss z
static java.lang.String	dateTimeStr(long epochTime) Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss z
static java.lang.String	dateTimeStrMsec(java.util.Date epochTime) Returns epochTime as a string, including msec, in the format MM-dd-yyyy HH:mm:ss.SSS z
static java.lang.String	dateTimeStrMsec(long epochTime) Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss.SSS z
java.lang.String	dateTimeStrMsecForTimezone(long epochTime) Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss.SSS z but does so for the Timezone specified by this Time object.
static java.lang.String	elapsedTimeStr(long msec) Returns the elapsed time in msec as a string.
int	getDayOfYear(java.util.Date epochDate) Returns day of year.
long	getEpochTime(int secondsIntoDay, java.util.Date referenceDate) Converts secondsIntoDay into an epoch time.
long	getEpochTime(int secondsIntoDay, long referenceTime) Converts secondsIntoDay into an epoch time.
int	getMsecsIntoDay(java.util.Date epochTime) Converts the epoch time into number of msec into the day.
long	getMsecsIntoDay(java.util.Date epochTime, long referenceTimeIntoDayMsecs) Returns time of day in msecs.
int	getSecondsIntoDay(java.util.Date epochDate) Converts the epoch time into number of seconds into the day.
int	getSecondsIntoDay(long epochTime) Converts the epoch time into number of seconds into the day.
static long	getStartOfDay(java.util.Date date) Returns the epoch time of the start of the current day for the default timezone.
static long	getStartOfDay(java.util.Date date, java.util.TimeZone tz) Returns the epoch time of the start of the day for the date and timezone specified.
static int	getTimeDifference(int time1SecsIntoDay, int time2SecsIntoDay) Returns the absolute value of the difference between the two times.
static java.lang.String	httpDate(long epochTime) For when sending date as part of http request.
static void	main(java.lang.String[] args)
static java.lang.String	minutesStr(long msec) Outputs time in minutes with a single digit past the decimal point
static java.util.Date	parse(java.lang.String datetimeStr) Parses the datetimeStr and returns a Date object.
static java.util.Date	parseDate(java.lang.String dateStr) Parses the dateStr and returns a Date object.
static int	parseTimeOfDay(java.lang.String timeStr) Parses a time such as HH:MM:SS or HH:MM into seconds into the day.
java.util.Date	parseUsingTimezone(java.lang.String dateStr) Parses the dateStr into a Date using the timezone for this Time object.
static java.lang.String	secondsStr(long msec) Outputs time in seconds with a single digit past the decimal point
static void	sleep(long msec) Simply calls Thread.sleep() but catches the InterruptedException so that the calling function doesn't need to.
static java.lang.String	timeOfDayAmPmStr(java.lang.Integer secInDay) Converts seconds in day to a string HH:MM AM/PM.
static java.lang.String	timeOfDayAmPmStr(long secInDay) Converts seconds in day to a string HH:MM AM/PM.
static java.lang.String	timeOfDayShortStr(java.lang.Integer secInDay) Converts seconds in day to a string HH:MM.
static java.lang.String	timeOfDayShortStr(long secInDay) Converts seconds in day to a string HH:MM.
static java.lang.String	timeOfDayStr(java.lang.Integer secInDay) Converts seconds in day to a string HH:MM:SS.
static java.lang.String	timeOfDayStr(long secInDay) Converts seconds in day to a string HH:MM:SS.
static java.lang.String	timeStr(java.util.Date epochTime) Returns just the time string in format "HH:mm:ss z"
static java.lang.String	timeStr(long epochTime) Returns just the time string in format "HH:mm:ss z"
java.lang.String	timeStrForTimezone(long epochTime)
static java.lang.String	timeStrMsec(java.util.Date epochTime) Returns just the time string.
static java.lang.String	timeStrMsec(long epochTime) Returns just the time string.
static java.lang.String	timeStrMsecNoTimeZone(java.util.Date epochTime) Returns just the time string.
static java.lang.String	timeStrMsecNoTimeZone(long epochTime) Returns just the time string.
static java.lang.String	timeStrNoTimeZone(java.util.Date epochTime) Returns just the time string in format "HH:mm:ss"
static java.lang.String	timeStrNoTimeZone(long epochTime) Returns just the time string in format "HH:mm:ss"

Methods inherited from class java.lang.Object

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

Field Detail

MS_PER_SEC

public static final int MS_PER_SEC

See Also:

Constant Field Values

SEC_IN_MSECS

public static final int SEC_IN_MSECS

See Also:

Constant Field Values

MS_PER_MIN

public static final int MS_PER_MIN

See Also:

Constant Field Values

MIN_IN_MSECS

public static final int MIN_IN_MSECS

See Also:

Constant Field Values

MS_PER_HOUR

public static final long MS_PER_HOUR

See Also:

Constant Field Values

HOUR_IN_MSECS

public static final long HOUR_IN_MSECS

See Also:

Constant Field Values

MS_PER_DAY

public static final long MS_PER_DAY

See Also:

Constant Field Values

DAY_IN_MSECS

public static final long DAY_IN_MSECS

See Also:

Constant Field Values

MS_PER_WEEK

public static final long MS_PER_WEEK

See Also:

Constant Field Values

WEEK_IN_MSECS

public static final long WEEK_IN_MSECS

See Also:

Constant Field Values

MS_PER_YEAR

public static final long MS_PER_YEAR

See Also:

Constant Field Values

YEAR_IN_MSECS

public static final long YEAR_IN_MSECS

See Also:

Constant Field Values

SEC_PER_MIN

public static final int SEC_PER_MIN

See Also:

Constant Field Values

MIN_IN_SECS

public static final int MIN_IN_SECS

See Also:

Constant Field Values

SEC_PER_HOUR

public static final int SEC_PER_HOUR

See Also:

Constant Field Values

HOUR_IN_SECS

public static final int HOUR_IN_SECS

See Also:

Constant Field Values

SEC_PER_DAY

public static final int SEC_PER_DAY

See Also:

Constant Field Values

DAY_IN_SECS

public static final int DAY_IN_SECS

See Also:

Constant Field Values

MIN_PER_HOUR

public static final int MIN_PER_HOUR

See Also:

Constant Field Values

HOUR_IN_MINS

public static final int HOUR_IN_MINS

See Also:

Constant Field Values

NSEC_PER_MSEC

public static final long NSEC_PER_MSEC

See Also:

Constant Field Values

MSEC_IN_NSECS

public static final long MSEC_IN_NSECS

See Also:

Constant Field Values

Constructor Detail

Time

public Time(DbConfig dbConfig)

Methods

Time

public Time(java.lang.String timeZoneStr)

Creates a Time object for the specified timezone. Useful for when have to frequently call members such as getSecondsIntoDay() that need an expensive calendar object.

Parameters:

timeZoneStr - Such as "America/Los_Angeles" . List of time zones can be found at http://en.wikipedia.org/wiki/List_of_tz_database_time_zones . If null then local timezone is used

Method Detail

getSecondsIntoDay

public int getSecondsIntoDay(long epochTime)

Converts the epoch time into number of seconds into the day.

Parameters:

epochTime -

Returns:

seconds into the day

getSecondsIntoDay

public int getSecondsIntoDay(java.util.Date epochDate)

Converts the epoch time into number of seconds into the day.

Parameters:

epochTime -

Returns:

seconds into the day

getDayOfYear

public int getDayOfYear(java.util.Date epochDate)

Returns day of year. This method is not threadsafe in that it first sets the time of the calendar and then gets the day of the year without synchronizing the calendar. But this is a bit faster.

Parameters:

epochDate -

Returns:

getMsecsIntoDay

public int getMsecsIntoDay(java.util.Date epochTime)

Converts the epoch time into number of msec into the day.

Parameters:

epochTime -

Returns:

msec into the day

getStartOfDay

public static long getStartOfDay(java.util.Date date,
                                 java.util.TimeZone tz)

Returns the epoch time of the start of the day for the date and timezone specified.

Parameters:

date - the time that the start of the day is needed for

tz - the timezone

Returns:

start of the current day

getStartOfDay

public static long getStartOfDay(java.util.Date date)

Returns the epoch time of the start of the current day for the default timezone. The default timezone should be set by the application at startup using TimeZone.setDefault(TimeZone.getTimeZone(timezoneName)).

Parameters:

date - the time that the start of the day is needed for

Returns:

start of the current day

getEpochTime

public long getEpochTime(int secondsIntoDay,
                         java.util.Date referenceDate)

Converts secondsIntoDay into an epoch time.

Parameters:

secondsIntoDay - To be converted into epoch time

referenceDate - The approximate epoch time so that can handle times before and after midnight.

Returns:

epoch time

getEpochTime

public long getEpochTime(int secondsIntoDay,
                         long referenceTime)

Converts secondsIntoDay into an epoch time.

Parameters:

secondsIntoDay - To be converted into epoch time

referenceTime - The approximate epoch time so that can handle times before and after midnight.

Returns:

epoch time

getMsecsIntoDay

public long getMsecsIntoDay(java.util.Date epochTime,
                            long referenceTimeIntoDayMsecs)

Returns time of day in msecs. But uses reference time to determine if interested in a time before midnight (a negative value) or a time past midnight (greater than 24 hours). This way when looking at schedule adherence and such it is much easier to deal with situations where have blocks that span midnight. Only need to get the time and do schedule adherence comparison once.

Parameters:

epochTime -

referenceTimeIntoDayMsecs -

Returns:

parseUsingTimezone

public java.util.Date parseUsingTimezone(java.lang.String dateStr)
                                  throws java.text.ParseException

Parses the dateStr into a Date using the timezone for this Time object.

Parameters:

dateStr -

Returns:

Throws:

java.text.ParseException

parse

public static java.util.Date parse(java.lang.String datetimeStr)
                            throws java.text.ParseException

Parses the datetimeStr and returns a Date object. Format is "MM-dd-yyyy HH:mm:ss z". Tries multiple formats including with milliseconds and with and without time zones.

Parameters:

datetimeStr -

Returns:

Throws:

java.text.ParseException

parseDate

public static java.util.Date parseDate(java.lang.String dateStr)
                                throws java.text.ParseException

Parses the dateStr and returns a Date object. Format of date is "MM-dd-yyyy".

Parameters:

dateStr -

Returns:

Throws:

java.text.ParseException

parseTimeOfDay

public static int parseTimeOfDay(java.lang.String timeStr)

Parses a time such as HH:MM:SS or HH:MM into seconds into the day. Instead of using SimpleDateFormat or such this function does the conversion directly and simply in order to be quicker. This is useful for reading in large volumes of GTFS data and such.

Returns:

Seconds into the day

timeOfDayStr

public static java.lang.String timeOfDayStr(long secInDay)

Converts seconds in day to a string HH:MM:SS. Note: secInDay can be negative.

Parameters:

secInDay -

Returns:

timeOfDayStr

public static java.lang.String timeOfDayStr(java.lang.Integer secInDay)

Converts seconds in day to a string HH:MM:SS. If secInDay null then returns null. Note: secInDay can be negative.

Parameters:

secInDay -

Returns:

Can be null

timeOfDayShortStr

public static java.lang.String timeOfDayShortStr(long secInDay)

Converts seconds in day to a string HH:MM. Note: secInDay can be negative.

Parameters:

secInDay -

Returns:

timeOfDayShortStr

public static java.lang.String timeOfDayShortStr(java.lang.Integer secInDay)

Converts seconds in day to a string HH:MM. If secInDay null then returns null. Note: secInDay can be negative.

Parameters:

secInDay -

Returns:

Can be null

timeOfDayAmPmStr

public static java.lang.String timeOfDayAmPmStr(long secInDay)

Converts seconds in day to a string HH:MM AM/PM. Note: secInDay can be negative.

Parameters:

secInDay -

Returns:

timeOfDayAmPmStr

public static java.lang.String timeOfDayAmPmStr(java.lang.Integer secInDay)

Converts seconds in day to a string HH:MM AM/PM. Note: secInDay can be negative.

Parameters:

secInDay - Can be null

Returns:

minutesStr

public static java.lang.String minutesStr(long msec)

Outputs time in minutes with a single digit past the decimal point

Parameters:

msec -

Returns:

secondsStr

public static java.lang.String secondsStr(long msec)

Outputs time in seconds with a single digit past the decimal point

Parameters:

msec -

Returns:

elapsedTimeStr

public static java.lang.String elapsedTimeStr(long msec)

Returns the elapsed time in msec as a string. If the time is below 1 minute then it is displayed in seconds. If greater than 2 minutes then it is displayed in minutes. For both, 1 digit after the decimal point is displayed. The units, either " sec" or " msec" are appended.

Parameters:

msec -

Returns:

dateStr

public static java.lang.String dateStr(long epochTime)

Returns date in format "MM-dd-yyyy"

Parameters:

epochTime -

Returns:

dateStr

public static java.lang.String dateStr(java.util.Date epochTime)

Returns date in format "MM-dd-yyyy"

Parameters:

epochTime -

Returns:

dateTimeStr

public static java.lang.String dateTimeStr(long epochTime)

Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss z

Parameters:

epochTime -

Returns:

dateTimeStr

public static java.lang.String dateTimeStr(java.util.Date epochTime)

Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss z

Parameters:

epochTime -

Returns:

dateTimeStrMsec

public static java.lang.String dateTimeStrMsec(long epochTime)

Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss.SSS z

Parameters:

epochTime -

Returns:

dateTimeStrMsecForTimezone

public java.lang.String dateTimeStrMsecForTimezone(long epochTime)

Returns epochTime as a string in the format MM-dd-yyyy HH:mm:ss.SSS z but does so for the Timezone specified by this Time object.

Parameters:

epochTime -

Returns:

timeStrForTimezone

public java.lang.String timeStrForTimezone(long epochTime)

dateTimeStrMsec

public static java.lang.String dateTimeStrMsec(java.util.Date epochTime)

Returns epochTime as a string, including msec, in the format MM-dd-yyyy HH:mm:ss.SSS z

Parameters:

epochTime -

Returns:

timeStr

public static java.lang.String timeStr(long epochTime)

Returns just the time string in format "HH:mm:ss z"

Parameters:

epochTime -

Returns:

timeStr

public static java.lang.String timeStr(java.util.Date epochTime)

Returns just the time string in format "HH:mm:ss z"

Parameters:

epochTime -

Returns:

timeStrNoTimeZone

public static java.lang.String timeStrNoTimeZone(long epochTime)

Returns just the time string in format "HH:mm:ss"

Parameters:

epochTime -

Returns:

timeStrNoTimeZone

public static java.lang.String timeStrNoTimeZone(java.util.Date epochTime)

Returns just the time string in format "HH:mm:ss"

Parameters:

epochTime -

Returns:

timeStrMsec

public static java.lang.String timeStrMsec(java.util.Date epochTime)

Returns just the time string. Includes msec.

Parameters:

epochTime -

Returns:

timeStrMsec

public static java.lang.String timeStrMsec(long epochTime)

Returns just the time string. Includes msec. e.g. "HH:mm:ss.SSS z"

Parameters:

epochTime -

Returns:

timeStrMsecNoTimeZone

public static java.lang.String timeStrMsecNoTimeZone(long epochTime)

Returns just the time string. Includes msec but no timezone. e.g. "HH:mm:ss.SSS"

Parameters:

epochTime -

Returns:

timeStrMsecNoTimeZone

public static java.lang.String timeStrMsecNoTimeZone(java.util.Date epochTime)

Returns just the time string. Includes msec but no timezone. e.g. "HH:mm:ss.SSS"

Parameters:

epochTime -

Returns:

httpDate

public static java.lang.String httpDate(long epochTime)

For when sending date as part of http request. Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123

Parameters:

epochTime -

Returns:

getTimeDifference

public static int getTimeDifference(int time1SecsIntoDay,
                                    int time2SecsIntoDay)

Returns the absolute value of the difference between the two times. If the difference is greater than 12 hours then 24hours-difference is returned. This is useful for when the times wrap around midnight. For example, if the times are 11:50pm and 12:05am then the difference will be 15 minutes instead of 23 hours and 45 minutes.

Parameters:

time1SecsIntoDay -

time2SecsIntoDay -

Returns:

The absolute value of the difference between the two times

sleep

public static void sleep(long msec)

Simply calls Thread.sleep() but catches the InterruptedException so that the calling function doesn't need to.

Parameters:

msec -

main

public static void main(java.lang.String[] args)