Package com.apptus.esales.connector.time

Class TimePoint

java.lang.Object

com.apptus.esales.connector.time.TimePoint

All Implemented Interfaces:

Comparable<TimePoint>

public class TimePoint
extends Object
implements Comparable<TimePoint>

A point on the time scale. An object of this class represents a specific point in time regardless of time zone or locale.

Time points are immutable objects that can be compared or converted to and from standard Java time objects like Calendar, Date or time in milliseconds since 1 January 1970 (i.e. Epoch time).

New time points can be calculated relative to this time point, using the methods forward, back, next, floor, ceil and round.

ISO 8601 representations of date and time can be obtained by calling the date, weekDate, ordinalDate, time or dateTime methods supplying a local time zone and a locale (for week dates).

Convenience methods for creating time points for the current time and for the beginning of the today are also included.

Field Summary

Fields

Modifier and Type	Field	Description
static Locale	ISO8601
static TimeZone	LOCAL
static TimeZone	UTC

Method Summary

Modifier and Type	Method	Description
TimePoint	back(int amount, Unit unit, TimeZone tz)	Equivalent to calling back(Duration.create(amount, unit), tz).
TimePoint	back(Duration duration, TimeZone tz)	Returns a new time point moved back the length of a duration.
TimePoint	ceil(Unit precision, TimeZone tz, Locale locale)	Round this time point up to the closest whole unit.
int	compareTo(TimePoint that)
CalendarDate	date(TimeZone tz)	Returns the calendar date (YYYY-MM-DD) representing the day of this time point, observing local time zone.
IsoDateTime	dateTime(TimeZone tz)	Returns the date and time (YYYY-MM-DDTHH:MM:SS) for this time point, observing local time zone.
static TimePoint	endOfToday(TimeZone tz)
boolean	equals(Object o)
TimePoint	floor(Unit precision, TimeZone tz, Locale locale)	Round this time point down to the closest whole unit.
TimePoint	forward(int amount, Unit unit, TimeZone tz)	Equivalent to calling forward(Duration.create(amount, unit), tz).
TimePoint	forward(Duration duration, TimeZone tz)	Returns a new time point moved forward the length of a duration.
static TimePoint	fromCalendar(Calendar calendar)
static TimePoint	fromDate(Date date)
static TimePoint	fromMillis(long millis)
int	hashCode()
TimePoint	next(int amount, Unit unit, TimeZone tz, Locale locale)	Equivalent to calling next(Duration.create(amount, unit), tz, locale).
TimePoint	next(Duration duration, TimeZone tz, Locale locale)	Returns a new time point representing the start of the next period as defined by a duration.
static TimePoint	now()
OrdinalDate	ordinalDate(TimeZone tz)	Returns the ordinal date (YYYY-DDD) representing the day of this time point, observing local time zone.
static TimePoint	parse(String iso, TimeZone tz)	Parses a date-time specification as defined by ISO 8601 and returns a time point valid for the specified date-time.
TimePoint	round(Unit precision, TimeZone tz, Locale locale)	Round this time point to the closest whole unit.
Time	time(TimeZone tz)	Returns the time of day (HH:MM:SS) for this time point, observing local time zone.
GregorianCalendar	toCalendar(TimeZone tz)	Converts this time point to a Gregorian calendar with the specified time zone and the default locale.
GregorianCalendar	toCalendar(TimeZone tz, Locale locale)	Converts this time point to a Gregorian calendar with the specified time zone and locale.
Date	toDate()	Converts this time point to a java.util.Date object.
static TimePoint	today(TimeZone tz)
long	toMillis()	Converts this time point to Epoch time, i.e.
String	toString()	Returns a string on the format YYYY-MM-DDTHH:MM:SSZ representing this time point.
String	toString(boolean formal)	If formal, returns a string on the format YYYY-MM-DDTHH:MM:SSZ representing this time point.
WeekDate	weekDate(TimeZone tz)	Returns the week date (YYYY-Www-D) representing the day of this time point, observing local time zone and local week rules.

Methods inherited from class java.lang.Object

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

Field Detail

UTC

public static final TimeZone UTC

LOCAL

public static final TimeZone LOCAL

ISO8601

public static final Locale ISO8601

Method Detail

now

public static TimePoint now()

Returns:

a time point representing the current time.

today

public static TimePoint today(TimeZone tz)

Parameters:

tz - The local time zone.

Returns:

a time point representing the start of today.

endOfToday

public static TimePoint endOfToday(TimeZone tz)

Parameters:

tz - The local time zone.

Returns:

a time point representing the end of today.

fromMillis

public static TimePoint fromMillis(long millis)

Parameters:

millis - epoch time

Returns:

Converts a Java Epoch time to a time point.

fromDate

public static TimePoint fromDate(Date date)

Parameters:

date - Date object

Returns:

Converts a Java Date object to a time point.

fromCalendar

public static TimePoint fromCalendar(Calendar calendar)

Parameters:

calendar - Calendar object

Returns:

Converts a Java Calendar object to a time point.

parse

public static TimePoint parse(String iso,
                              TimeZone tz)

Parses a date-time specification as defined by ISO 8601 and returns a time point valid for the specified date-time.

Parameters:

iso - The input string.

tz - The local time zone.

Returns:

A time point.

next

public TimePoint next(int amount,
                      Unit unit,
                      TimeZone tz,
                      Locale locale)

Equivalent to calling next(Duration.create(amount, unit), tz, locale).

Parameters:

amount - The amount of units.

unit - Unit of time.

tz - The locale time zone.

locale - The locale.

Returns:

A new time point.

next

public TimePoint next(Duration duration,
                      TimeZone tz,
                      Locale locale)

Returns a new time point representing the start of the next period as defined by a duration.

If this time point is at the start of a period, then the new time point is moved forward by the length of the duration. Otherwise, the new time point is the ceiling of this time point, with the precision of the duration used as unit.

Parameters:

duration - The duration of a period.

tz - The local time zone.

locale - The locale.

Returns:

A new time point.

forward

public TimePoint forward(int amount,
                         Unit unit,
                         TimeZone tz)

Equivalent to calling forward(Duration.create(amount, unit), tz).

Parameters:

amount - The amount of units.

unit - Unit of time.

tz - The locale time zone.

Returns:

a new time point.

forward

public TimePoint forward(Duration duration,
                         TimeZone tz)

Returns a new time point moved forward the length of a duration.

Parameters:

duration - The duration to move forward.

tz - The local time zone.

Returns:

A new time point.

back

public TimePoint back(int amount,
                      Unit unit,
                      TimeZone tz)

Equivalent to calling back(Duration.create(amount, unit), tz).

Parameters:

amount - The amount of units.

unit - Unit of time.

tz - The locale time zone.

Returns:

a new time point.

back

public TimePoint back(Duration duration,
                      TimeZone tz)

Returns a new time point moved back the length of a duration.

Parameters:

duration - The duration to move back.

tz - The local time zone.

Returns:

A new time point.

floor

public TimePoint floor(Unit precision,
                       TimeZone tz,
                       Locale locale)

Round this time point down to the closest whole unit. Will return a time equal to this time point if the time point is already rounded.

Parameters:

precision - The unit to round to.

tz - The local time zone.

locale - The locale.

Returns:

A new time point.

ceil

public TimePoint ceil(Unit precision,
                      TimeZone tz,
                      Locale locale)

Round this time point up to the closest whole unit. Will return a time equal to this time point if the time point is already rounded.

Parameters:

precision - The unit to round to.

tz - The local time zone.

locale - The locale.

Returns:

A new time point.

round

public TimePoint round(Unit precision,
                       TimeZone tz,
                       Locale locale)

Round this time point to the closest whole unit. Will return a time equal to this time point if the time point is already rounded.

Parameters:

precision - The unit to round to.

tz - The local time zone.

locale - The locale.

Returns:

A new time point.

date

public CalendarDate date(TimeZone tz)

Returns the calendar date (YYYY-MM-DD) representing the day of this time point, observing local time zone.

Parameters:

tz - The local time zone.

Returns:

A calendar date.

weekDate

public WeekDate weekDate(TimeZone tz)

Returns the week date (YYYY-Www-D) representing the day of this time point, observing local time zone and local week rules.

Parameters:

tz - The local time zone.

Returns:

A calendar date.

ordinalDate

public OrdinalDate ordinalDate(TimeZone tz)

Returns the ordinal date (YYYY-DDD) representing the day of this time point, observing local time zone.

Parameters:

tz - The local time zone.

Returns:

A calendar date.

time

public Time time(TimeZone tz)

Returns the time of day (HH:MM:SS) for this time point, observing local time zone.

Parameters:

tz - The local time zone.

Returns:

A time of day.

dateTime

public IsoDateTime dateTime(TimeZone tz)

Returns the date and time (YYYY-MM-DDTHH:MM:SS) for this time point, observing local time zone.

Parameters:

tz - The local time zone.

Returns:

A date and time.

toCalendar

public GregorianCalendar toCalendar(TimeZone tz)

Converts this time point to a Gregorian calendar with the specified time zone and the default locale.

Parameters:

tz - The time zone.

Returns:

A Gregorian calendar with this time point as current time.

toCalendar

public GregorianCalendar toCalendar(TimeZone tz,
                                    Locale locale)

Converts this time point to a Gregorian calendar with the specified time zone and locale.

Parameters:

tz - The time zone.

locale - The locale.

Returns:

A Gregorian calendar with this time point as current time.

toDate

public Date toDate()

Converts this time point to a java.util.Date object.

Returns:

java.util.Date object representation of this time point.

toMillis

public long toMillis()

Converts this time point to Epoch time, i.e. the number of milliseconds from 1 January 1970 UTC.

Returns:

epoch time of this time point.

compareTo

public int compareTo(TimePoint that)

Specified by:

compareTo in interface Comparable<TimePoint>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string on the format YYYY-MM-DDTHH:MM:SSZ representing this time point.

Overrides:

toString in class Object

toString

public String toString(boolean formal)

If formal, returns a string on the format YYYY-MM-DDTHH:MM:SSZ representing this time point. Otherwise, a string on the format YYYY-MM-DD HH.MM.SS in the local time zone.

Parameters:

formal - formal representation of time point.

Returns:

string of time point.