Package com.apptus.esales.connector.time

Class TimeInterval

java.lang.Object

com.apptus.esales.connector.time.TimeInterval

public class TimeInterval
extends Object

An interval between two points in time. The interval may be expressed as either a start and an end time, or as one of those and a duration.

This class represents the ISO 8601 time interval concept, which allows the different formats to express a time interval:

• <start>/<duration>
• <start>/<end>
• <duration>/<end>

where start and end is specified using ISO 8601 date and time, while a duration is specified using a ISO 8601 duration.

Author:

Thomas Raneland, Robert Åkemalm

Method Summary

Modifier and Type	Method	Description
static TimeInterval	create(Duration duration, IsoDateTime end)	Creates a time interval with the specified duration ending at the specified end date-time.
static TimeInterval	create(IsoDateTime start, Duration duration)	Creates a time interval from the specified start date-time with the specified duration.
static TimeInterval	create(IsoDateTime start, IsoDateTime end)	Creates a time interval between the specified start and end date-times.
static TimeInterval	day(int year, Month month, int day)	Convenience method for returning a time interval covering a complete calendar day.
Duration	duration(TimeZone tz)	Returns the duration of this time interval.
TimePoint	end(TimeZone tz)	Returns the end point in time, given the time zone for local time.
boolean	equals(Object o)	True if the argument is a time interval specified by the very same components as this time interval.
int	hashCode()
static TimeInterval	month(int year, Month month)	Convenience method for returning a time interval covering a complete calendar month.
static TimeInterval	parse(String iso)	Parses a time interval on any of the three valid formats.
static TimeInterval	quarter(int year, int quarter)	Convenience method for returning a time interval covering a complete calendar quarter.
TimePoint	start(TimeZone tz)	Returns the start point in time, given the time zone for local time.
static TimeInterval	today(TimeZone tz)	Convenience method for returning a time interval covering today.
long	toMillis(TimeZone tz)	Returns the length in milliseconds for this time interval, given a local time zone.
String	toString()	Returns an ISO 8601 formatted string representing this time interval.
static TimeInterval	week(int year, int week, Locale locale)	Convenience method for returning a time interval covering a complete calendar week according to the week rules defined by the specified locale.
static TimeInterval	year(int year)	Convenience method for returning a time interval covering a complete calendar year.

Methods inherited from class java.lang.Object

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

Method Detail

year

public static TimeInterval year(int year)

Convenience method for returning a time interval covering a complete calendar year. The start date is expressed in local time.

Parameters:

year - The year.

Returns:

A time interval with duration 1 year, starting at year-01-01.

quarter

public static TimeInterval quarter(int year,
                                   int quarter)

Convenience method for returning a time interval covering a complete calendar quarter. The start date is expressed in local time.

Parameters:

year - The year.

quarter - The quarter.

Returns:

A time interval with duration 3 months, starting at the first month of the quarter.

month

public static TimeInterval month(int year,
                                 Month month)

Convenience method for returning a time interval covering a complete calendar month. The start date is expressed in local time.

Parameters:

year - The year.

month - The month.

Returns:

A time interval with duration 1 month, starting at the first day of the month.

week

public static TimeInterval week(int year,
                                int week,
                                Locale locale)

Convenience method for returning a time interval covering a complete calendar week according to the week rules defined by the specified locale. The start date is expressed in local time.

Parameters:

year - The week year.

week - The week.

locale - The locale, controlling week rules.

Returns:

A time interval with duration 1 week, starting at the first day of the week.

day

public static TimeInterval day(int year,
                               Month month,
                               int day)

Convenience method for returning a time interval covering a complete calendar day. The start date is expressed in local time.

Parameters:

year - The year.

month - The month.

day - The day.

Returns:

A time interval with duration 1 day, starting at 00:00:00 on the specified day.

today

public static TimeInterval today(TimeZone tz)

Convenience method for returning a time interval covering today. The start date is expressed in local time.

Parameters:

tz - Time zone to decide which day is "today".

Returns:

A time interval with duration 1 day, starting at 00:00:00 today.

create

public static TimeInterval create(IsoDateTime start,
                                  IsoDateTime end)

Creates a time interval between the specified start and end date-times.

Parameters:

start - start date-time.

end - end date-time.

Returns:

interval between start and end.

create

public static TimeInterval create(IsoDateTime start,
                                  Duration duration)

Creates a time interval from the specified start date-time with the specified duration.

Parameters:

start - start date-time.

duration - duration of interval.

Returns:

interval with a specified start

create

public static TimeInterval create(Duration duration,
                                  IsoDateTime end)

Creates a time interval with the specified duration ending at the specified end date-time.

Parameters:

duration - duration of interval.

end - end date-time.

Returns:

interval with specified end.

parse

public static TimeInterval parse(String iso)

Parses a time interval on any of the three valid formats.

Parameters:

iso - The input string.

Returns:

A time interval.

Throws:

IllegalArgumentException - if the input cannot be parsed.

start

public TimePoint start(TimeZone tz)

Returns the start point in time, given the time zone for local time.

Parameters:

tz - The local time zone.

Returns:

The start point in time.

end

public TimePoint end(TimeZone tz)

Returns the end point in time, given the time zone for local time.

Parameters:

tz - The local time zone.

Returns:

The end point in time.

duration

public Duration duration(TimeZone tz)

Returns the duration of this time interval. If this interval was specified by start and end times, the duration is calculated given a local time zone. Note that if the duration is calculated, it will be specified in hours, minutes and seconds only. The number of hours may be very large for long intervals.

Parameters:

tz - The local time zone.

Returns:

The length of this time interval.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

True if the argument is a time interval specified by the very same components as this time interval.

Two time intervals may cover the same set of time points in all time zones and for all locales and still not be considered equal, depending on how they are specified.

Overrides:

equals in class Object

toString

public String toString()

Returns an ISO 8601 formatted string representing this time interval.

Overrides:

toString in class Object

toMillis

public long toMillis(TimeZone tz)

Returns the length in milliseconds for this time interval, given a local time zone.

Parameters:

tz - The local time zone.

Returns:

The length in milliseconds of this interval.