com.inrix.sdk.utils

Class InrixDateUtils

java.lang.Object

com.inrix.sdk.utils.InrixDateUtils

public final class InrixDateUtils
extends Object

Contains static methods for converting dates to and from formatted strings.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INRIX_DATE_FORMAT The INRIX date format, using default time zone.
static String	INRIX_DATE_FORMAT_FRACTIONAL_SECONDS The INRIX date format, including fractional seconds.

Method Summary

Methods

Modifier and Type	Method and Description
static Date	convertDateToEOD(Date date) Convert date to the end of a day.
static Date	convertDateToSOD(Date date) Convert date to the start of a day.
static Date	getDateFromString(String str) Parses the date as a string and returns the date object.
static Date	getDateFromString(String str, boolean fractionalSeconds) Parses the date as a string and returns the date object.
static int	getDayOffset(Date start, Date end) Get the offset between two dates in days.
static List<Date>	getEncompassingDates(Date start, Date end) Gets the list of dates that are included in the given range.
static Calendar	getNowAsUtc() Utility method which returns the current local time (on the device) as timezone "UTC" useful for when dealing with Schedules.
static String	getStringFromDateUtc(Date date) Converts the specified UTC date to an INRIX time format string.
static String	getStringFromDateUtc(Date date, boolean fractionalSeconds) Converts the specified UTC date to an INRIX time format string.
static boolean	isSameDay(Date date1, Date date2) Compares to see if two dates fall on the same day, irrespective of locale.
static Date	round(Date date, int offsetMinutes) Round the specified date to the nearest minute offset.
static Date	roundDown(Date date, int offsetMinutes) Round down specified date to the nearest value.
static Date	roundUp(Date date, int offsetMinutes) Round up specified date to the nearest value.

Methods inherited from class java.lang.Object

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

Field Detail

INRIX_DATE_FORMAT

public static final String INRIX_DATE_FORMAT

The INRIX date format, using default time zone.

See Also:

Constant Field Values

INRIX_DATE_FORMAT_FRACTIONAL_SECONDS

public static final String INRIX_DATE_FORMAT_FRACTIONAL_SECONDS

The INRIX date format, including fractional seconds.

See Also:

Constant Field Values

Method Detail

getDateFromString

public static Date getDateFromString(String str)
                              throws ParseException

Parses the date as a string and returns the date object. The String must be in the following format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'". The time zone is UTC.

Parameters:

str - The date as a string in INRIX time format.

Returns:

The converted date.

Throws:

ParseException - when str is not in the correct format.

getDateFromString

public static Date getDateFromString(String str,
                     boolean fractionalSeconds)
                              throws ParseException

Parses the date as a string and returns the date object. The String must be in INRIX time format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'" or "yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\'". The time zone is UTC.

Parameters:

str - The date as a string in INRIX time format.

fractionalSeconds - Whether the string includes fractional seconds or not.

Returns:

The converted date.

Throws:

ParseException - when str is not in the correct format.

getStringFromDateUtc

public static String getStringFromDateUtc(Date date)

Converts the specified UTC date to an INRIX time format string. This format is required for INRIX server requests.

Parameters:

date - The UTC date to be converted.

Returns:

The date formatted as "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'", or null if date is null.

getStringFromDateUtc

public static String getStringFromDateUtc(Date date,
                          boolean fractionalSeconds)

Converts the specified UTC date to an INRIX time format string. This format is required for INRIX server requests.

Parameters:

date - The UTC date to be converted.

fractionalSeconds - Whether the string should include fractional seconds or not.

Returns:

The date formatted as "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'" or "yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\'", or null if date is null.

roundUp

public static Date roundUp(Date date,
           int offsetMinutes)

Round up specified date to the nearest value.

Parameters:

date - Target date.

offsetMinutes - Nearest minutes offset.

Returns:

New date value.

roundDown

public static Date roundDown(Date date,
             int offsetMinutes)

Round down specified date to the nearest value.

Parameters:

date - Target date.

offsetMinutes - Nearest minutes offset.

Returns:

New date value.

round

public static Date round(Date date,
         int offsetMinutes)

Round the specified date to the nearest minute offset.

Parameters:

date - Target date.

offsetMinutes - Nearest minutes offset.

Returns:

New date value.

getNowAsUtc

public static Calendar getNowAsUtc()

Utility method which returns the current local time (on the device) as timezone "UTC" useful for when dealing with Schedules.

Returns:

The current local time with UTC timezone.

convertDateToSOD

public static Date convertDateToSOD(Date date)

Convert date to the start of a day.

Parameters:

date - The date to convert.

Returns:

A date representing the start of a day

convertDateToEOD

public static Date convertDateToEOD(Date date)

Convert date to the end of a day.

Parameters:

date - The date to convert.

Returns:

A date representing the end of a day

getDayOffset

public static int getDayOffset(Date start,
               Date end)

Get the offset between two dates in days.

Parameters:

start - The starting date to evaluate.

end - The ending date to evaluate.

Returns:

The days offset.

getEncompassingDates

public static List<Date> getEncompassingDates(Date start,
                              Date end)

Gets the list of dates that are included in the given range.

Parameters:

start - The starting date to evaluate.

end - The ending date to evaluate.

Returns:

A list of dates in the date range.

isSameDay

public static boolean isSameDay(Date date1,
                Date date2)

Compares to see if two dates fall on the same day, irrespective of locale.

Parameters:

date1 - Date to be compared.

date2 - Date to be compared to.

Returns:

true if both dates fall on same day, false otherwise.