Time2 (Time2 Library 2.0.0 API)

java.lang.Object
- ch.agent.t2.time.Time2

All Implemented Interfaces:

TimeIndex, Comparable<TimeIndex>

Direct Known Subclasses:

DateTime, Day, Month, SystemTime, ThirdFriday, Week, Workday, Year
```
public class Time2
extends Object
implements TimeIndex
```
Time2 implements the behavior of TimeIndex as an immutable object.
The design goals of Time2 are flexibility and performance. It is not a replacement for java.util.Date and is not a competitor to Joda Time. Time2 has no time zones, no daylight savings, no locales, no Gregorian cutover. Dates before October 15 1582 do not correspond to historical dates. The base of Time2 time is zero nanoseconds into January 1st of year zero:

0000-01-01 00:00:00.000000000

It corresponds to the numerical time index 0L.
Warning note about time comparisons
This class implements Comparable with simple semantics. Basically, it considers "earlier" as "smaller". When time domain differs, times are converted before performing the comparison. The conversion is done in the following fashion:
- If resolutions differ, the time with the lowest resolution is converted to the one with the highest resolution. For example comparing a "daily" time with y yearly time will compare the day specified to the implicit default day of the year specified (which is January 1).
- If resolutions do not differ, the times are converted to the unrestricted time domain for their resolution.
These semantics are not meaningful for all possible time domains. Applications using "exotic" time domains should consider writing a subclass of Time2 and override the compareTo method.
Author:

Jean-Paul Vetterli

Constructor Summary

Constructors
Constructor and Description
`Time2(TimeDomain domain, long time)` Construct a time index with the given time domain and numerical time index.
`Time2(TimeDomain domain, long year, int month, int day, int hour, int min, int sec, int fsec, Adjustment adjust)` Construct a time index with the given time domain and parameters.
`Time2(TimeDomain domain, String time)` Construct a time index with the given time domain and string.
`Time2(TimeDomain domain, String time, Adjustment adjustment)` Construct a time index with the given time domain and string, with possible adjustment.
`Time2(TimeDomain domain, TimeParts timeParts, Adjustment adjust)` Constructor a time index from a time parts object with an adjustment parameter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TimeIndex`	`add(long increment)` Return a new time index with the time incremented from this one.
`long`	`asLong()` Return the numeric index.
`int`	`asOffset()` Return the time as an offset from the origin.
`int`	`compareTo(TimeIndex otherTime)`
`TimeIndex`	`convert(TimeDomain domain)` Return a new time index by converting this one to the given time domain.
`TimeIndex`	`convert(TimeDomain domain, Adjustment adjustment)` Return a new time index by converting this one to the given time domain, possibly adjusting the time as specified.
`boolean`	`equals(Object obj)`
`int`	`getDay()` Return the day component of the time.
`TimeIndex`	`getDayByRank(Resolution basePeriod, DayOfWeek day, int rank)` Return the TimeIndex for a day defined by name and rank within a reference period.
`DayOfWeek`	`getDayOfWeek()` Return the day of the week.
`int`	`getFractionalSecond()` Return the sub-second component of the time.
`int`	`getHour()` Return the hour component of the time.
`int`	`getMinute()` Return the minute component of the time.
`int`	`getMonth()` Return the month component of the time.
`int`	`getSecond()` Return the second component of the time.
`TimeDomain`	`getTimeDomain()` Return the time domain.
`long`	`getYear()` Return the year component of the time.
`int`	`hashCode()`
`long`	`sub(TimeIndex time)` Return the number of time units since the time specified as argument.
`String`	`toString()`
`String`	`toString(String format)` Return a string representation of the time.
`String`	`toString(TimeFormatter formatter)` Return a string representation of the time.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Time2
```
public Time2(TimeDomain domain,
             long time)
```
    Construct a time index with the given time domain and numerical time index. An unchecked exception is thrown if the numerical time index is out of range. The range depends on the domain but is very large.
    
    Parameters:
    
    domain - a non-null time domain
    
    time - a valid numerical time index
  - Time2
```
public Time2(TimeDomain domain,
             long year,
             int month,
             int day,
             int hour,
             int min,
             int sec,
             int fsec,
             Adjustment adjust)
      throws T2Exception
```
    Construct a time index with the given time domain and parameters. An unchecked exception is thrown if the time specified is not valid for the domain. If necessary the time is adjusted as allowed by the last argument.
    See the comment in TimeDomain.time(String) for important details about discarding unnecessary time components.
    
    Parameters:
    
    domain - a non-null time domain
    
    year - a year, which can be unusually large, depending on the domain
    
    month - a number between 1 and 12
    
    day - the day in the month, starting with 1
    
    hour - an hour in the range 0-23
    
    min - a minute in the range 0-59
    
    sec - a second in the range 0-59
    
    fsec - a fraction of a second in the current second in the range 0-999999999
    
    adjust - a non-null allowed adjustment mode
    
    Throws:
    
    T2Exception
  - Time2
```
public Time2(TimeDomain domain,
             TimeParts timeParts,
             Adjustment adjust)
      throws T2Exception
```
    Constructor a time index from a time parts object with an adjustment parameter.
    
    Parameters:
    
    domain - the time domain
    
    timeParts - the time parts
    
    adjust - an adjustment
    
    Throws:
    
    T2Exception - on failure
  - Time2
```
public Time2(TimeDomain domain,
             String time,
             Adjustment adjustment)
      throws T2Exception
```
    Construct a time index with the given time domain and string, with possible adjustment. The string is interpreted by the TimeScanner defined in the time domain.
    If necessary the time is adjusted as allowed by the last argument.
    See the comment in TimeDomain.time(String) for important details about discarding unnecessary time components.
    
    Parameters:
    
    domain - a non-null time domain
    
    time - a string containing a representation of a date and time
    
    adjustment - a non-null allowed adjustment mode
    
    Throws:
    
    T2Exception
  - Time2
```
public Time2(TimeDomain domain,
             String time)
      throws T2Exception
```
    Construct a time index with the given time domain and string. The string is interpreted by the TimeScanner defined in the time domain.
    No adjustment is allowed.
    See the comment in TimeDomain.time(String) for important details about discarding unnecessary time components.
    
    Parameters:
    
    domain - a non-null time domain
    
    time - a string containing a representation of a date and time
    
    Throws:
    
    T2Exception
- Method Detail
  - convert
```
public TimeIndex convert(TimeDomain domain)
                  throws T2Exception
```
    Description copied from interface: TimeIndex
    
    Return a new time index by converting this one to the given time domain. No adjustment is allowed.
    
    Specified by:
    
    convert in interface TimeIndex
    
    Parameters:
    
    domain - a non-null time domain
    
    Returns:
    
    a time index in the given domain
    
    Throws:
    
    T2Exception
  - convert
```
public TimeIndex convert(TimeDomain domain,
                         Adjustment adjustment)
                  throws T2Exception
```
    Description copied from interface: TimeIndex
    
    Return a new time index by converting this one to the given time domain, possibly adjusting the time as specified.
    
    Specified by:
    
    convert in interface TimeIndex
    
    Parameters:
    
    domain - a non-null time domain
    
    adjustment - a non-null allowed adjustment
    
    Returns:
    
    a time index in the given domain
    
    Throws:
    
    T2Exception
  - getTimeDomain
```
public TimeDomain getTimeDomain()
```
    Description copied from interface: TimeIndex
    
    Return the time domain.
    
    Specified by:
    
    getTimeDomain in interface TimeIndex
    
    Returns:
    
    the time domain
  - asLong
```
public long asLong()
```
    Description copied from interface: TimeIndex
    
    Return the numeric index.
    
    Specified by:
    
    asLong in interface TimeIndex
    
    Returns:
    
    the numeric index
  - asOffset
```
public int asOffset()
             throws T2Exception
```
    Description copied from interface: TimeIndex
    
    Return the time as an offset from the origin. An exception is thrown if the offset does not fit into a 32 bit integer.
    
    Specified by:
    
    asOffset in interface TimeIndex
    
    Returns:
    
    the time as an offset from the origin
    
    Throws:
    
    T2Exception
  - add
```
public TimeIndex add(long increment)
              throws T2Exception
```
    Description copied from interface: TimeIndex
    
    Return a new time index with the time incremented from this one. For respective increments 1 and -1, the time returned correspond to the next and previous periods. An exception is thrown when the increment cannot be applied without causing an overflow.
    This method is related to sub(TimeIndex).
    
    Specified by:
    
    add in interface TimeIndex
    
    Parameters:
    
    increment - positive or negative number of units to add
    
    Returns:
    
    a new TimeIndex object
    
    Throws:
    
    T2Exception
  - sub
```
public long sub(TimeIndex time)
         throws T2Exception
```
    Description copied from interface: TimeIndex
    
    Return the number of time units since the time specified as argument. The result is negative if the argument corresponds to a later time. An exception is thrown if the domains are not equal.
    This method is related to add(long) in the following way:
    
    Specified by:
    
    sub in interface TimeIndex
    
    Parameters:
    
    time - a non-null time index to substract from this time index
    
    Returns:
    
    the number of periods between this time index and the argument, positive is the argument is earlier
    
    Throws:
    
    T2Exception
  - getYear
```
public long getYear()
```
    Description copied from interface: TimeIndex
    
    Return the year component of the time.
    
    Specified by:
    
    getYear in interface TimeIndex
    
    Returns:
    
    a number between 0 and the largest long
  - getMonth
```
public int getMonth()
```
    Description copied from interface: TimeIndex
    
    Return the month component of the time.
    
    Specified by:
    
    getMonth in interface TimeIndex
    
    Returns:
    
    a number between 1 and 12
  - getDay
```
public int getDay()
```
    Description copied from interface: TimeIndex
    
    Return the day component of the time.
    
    Specified by:
    
    getDay in interface TimeIndex
    
    Returns:
    
    a number between 1 and the number of days in the current month and year
  - getHour
```
public int getHour()
```
    Description copied from interface: TimeIndex
    
    Return the hour component of the time.
    
    Specified by:
    
    getHour in interface TimeIndex
    
    Returns:
    
    a number between 0 and 23.
  - getMinute
```
public int getMinute()
```
    Description copied from interface: TimeIndex
    
    Return the minute component of the time.
    
    Specified by:
    
    getMinute in interface TimeIndex
    
    Returns:
    
    a number between 0 and 59
  - getSecond
```
public int getSecond()
```
    Description copied from interface: TimeIndex
    
    Return the second component of the time.
    
    Specified by:
    
    getSecond in interface TimeIndex
    
    Returns:
    
    a number between 0 and 59
  - getFractionalSecond
```
public int getFractionalSecond()
```
    Description copied from interface: TimeIndex
    
    Return the sub-second component of the time.
    
    Specified by:
    
    getFractionalSecond in interface TimeIndex
    
    Returns:
    
    a number between 0 and 999999999
  - getDayOfWeek
```
public DayOfWeek getDayOfWeek()
                       throws T2Exception
```
    Description copied from interface: TimeIndex
    
    Return the day of the week. An exception is thrown if the time domain resolution is YEAR or MONTH
    
    Specified by:
    
    getDayOfWeek in interface TimeIndex
    
    Returns:
    
    the day of the week
    
    Throws:
    
    T2Exception
  - getDayByRank
```
public TimeIndex getDayByRank(Resolution basePeriod,
                              DayOfWeek day,
                              int rank)
                       throws T2Exception
```
    Description copied from interface: TimeIndex
    
    Return the TimeIndex for a day defined by name and rank within a reference period. A reference period is the current month or the current year. If the rank is negative, days are counted from the end, with -1 meaning the last day. The result is a TimeIndex with DAY resolution.
    
    Specified by:
    
    getDayByRank in interface TimeIndex
    
    Parameters:
    
    basePeriod - one of the values MONTH or YEAR
    
    day - the day name
    
    rank - the day rank
    
    Returns:
    
    a time index with DAY resolution
    
    Throws:
    
    T2Exception
  - toString
```
public String toString(TimeFormatter formatter)
```
    Description copied from interface: TimeIndex
    
    Return a string representation of the time. A time formatter can be specified. If null, the default formatter for the time domain will be used.
    
    Specified by:
    
    toString in interface TimeIndex
    
    Parameters:
    
    formatter - a time formatter or null
    
    Returns:
    
    a string representation of the time
  - toString
```
public String toString(String format)
```
    Description copied from interface: TimeIndex
    
    Return a string representation of the time. The order of the time components is: year, month, day, hour, minute, second, sub-second. Because the format string is a Formatter format, it is possible to reorder these components.
    For example "%04d%02d%02d" would produce 19700401 and "%3$d.%2$d.%1$04d" would produce 1.4.1970.
    As a special trick, when the format string is empty, the date is returned in the compact format d.m.yy, with the day and month without a leading zero, and the year starting at the 3d digit.
    If the argument is null, formatting is delegated to the default time formatter defined in the time factory.
    In case of errors in the format string, an IllegalFormatException is thrown.
    
    Specified by:
    
    toString in interface TimeIndex
    
    Parameters:
    
    format - a format string, or an empty string, or null
    
    Returns:
    
    a string representation of the time
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(TimeIndex otherTime)
```
    Specified by:
    
    compareTo in interface Comparable<TimeIndex>

Class Time2

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Time2

Time2

Time2

Time2

Time2

Method Detail

convert

convert

getTimeDomain

asLong

asOffset

add

sub

getYear

getMonth

getDay

getHour

getMinute

getSecond

getFractionalSecond

getDayOfWeek

getDayByRank

toString

toString

toString

equals

hashCode

compareTo