com.ibm.icu.util
Class UniversalTimeScale

java.lang.Object
  extended bycom.ibm.icu.util.UniversalTimeScale

Deprecated. This is a draft API and might change in a future release of ICU.

public final class UniversalTimeScale
extends Object

There are quite a few different conventions for binary datetime, depending on different platforms and protocols. Some of these have severe drawbacks. For example, people using Unix time (seconds since Jan 1, 1970) think that they are safe until near the year 2038. But cases can and do arise where arithmetic manipulations causes serious problems. Consider the computation of the average of two datetimes, for example: if one calculates them with averageTime = (time1 + time2)/2, there will be overflow even with dates around the present. Moreover, even if these problems don't occur, there is the issue of conversion back and forth between different systems.

Binary datetimes differ in a number of ways: the datatype, the unit, and the epoch (origin). We'll refer to these as time scales. For example:

Table 1: Binary Time Scales

Source Datatype Unit Epoch
JAVA_TIME long milliseconds Jan 1, 1970
UNIX_TIME int or long seconds Jan 1, 1970
ICU4C double milliseconds Jan 1, 1970
WINDOWS_FILE_TIME long ticks (100 nanoseconds) Jan 1, 1601
WINDOWS_DATE_TIME long ticks (100 nanoseconds) Jan 1, 0001
MAC_OLD_TIME int seconds Jan 1, 1904
MAC_TIME double seconds Jan 1, 2001
EXCEL_TIME ? days Dec 31, 1899
DB2_TIME ? days Dec 31, 1899

All of the epochs start at 00:00 am (the earliest possible time on the day in question), and are assumed to be UTC.

The ranges for different datatypes are given in the following table (all values in years). The range of years includes the entire range expressible with positive and negative values of the datatype. The range of years for double is the range that would be allowed without losing precision to the corresponding unit.

Units long double int
1 sec 5.84542×10¹¹ 285,420,920.94 136.10
1 millisecond 584,542,046.09 285,420.92 0.14
1 microsecond 584,542.05 285.42 0.00
100 nanoseconds (tick) 58,454.20 28.54 0.00
1 nanosecond 584.5420461 0.2854 0.00

This class implements a universal time scale which can be used as a 'pivot', and provide conversion functions to and from all other major time scales. This datetimes to be converted to the pivot time, safely manipulated, and converted back to any other datetime time scale.

So what to use for this pivot? Java time has plenty of range, but cannot represent Windows datetimes without severe loss of precision. ICU4C time addresses this by using a double that is otherwise equivalent to the Java time. However, there are disadvantages with doubles. They provide for much more graceful degradation in arithmetic operations. But they only have 53 bits of accuracy, which means that they will lose precision when converting back and forth to ticks. What would really be nice would be a long double (80 bits -- 64 bit mantissa), but that is not supported on most systems.

The Unix extended time uses a structure with two components: time in seconds and a fractional field (microseconds). However, this is clumsy, slow, and prone to error (you always have to keep track of overflow and underflow in the fractional field). BigDecimal would allow for arbitrary precision and arbitrary range, but we would not want to use this as the normal type, because it is slow and does not have a fixed size.

Because of these issues, we ended up concluding that the Windows datetime would be the best pivot. However, we use the full range allowed by the datatype, allowing for datetimes back to 29,000 BC and up to 29,000 AD. This time scale is very fine grained, does not lose precision, and covers a range that will meet almost all requirements. It will not handle the range that Java times would, but frankly, being able to handle dates before 29,000 BC or after 29,000 AD is of very limited interest. However, for those cases, we also allow conversion to an optional BigDecimal format that would have arbitrary precision and range.

Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

Field Summary
static int DB2_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int EPOCH_OFFSET_MINUS_1_VALUE
          Deprecated. The constant used to select the epoch offset minus one value for a time scale.
static int EPOCH_OFFSET_PLUS_1_VALUE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int EPOCH_OFFSET_VALUE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int EXCEL_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int FROM_MAX_VALUE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int FROM_MIN_VALUE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int ICU4C_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int JAVA_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int MAC_OLD_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int MAC_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int MAX_ROUND_VALUE
          Deprecated. The constant used to select the maximum safe rounding value for a time scale.
static int MAX_SCALE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int MAX_SCALE_VALUE
          Deprecated. The number of time scale values.
static int MIN_ROUND_VALUE
          Deprecated. The constant used to select the minimum safe rounding value for a time scale.
static int TO_MAX_VALUE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int TO_MIN_VALUE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int UNITS_ROUND_VALUE
          Deprecated. The constant used to select the units round value for a time scale.
static int UNITS_VALUE
          Deprecated. This is a draft API and might change in a future release of ICU.
static int UNIX_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int WINDOWS_DATE_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
static int WINDOWS_FILE_TIME
          Deprecated. This is a draft API and might change in a future release of ICU.
 
Method Summary
static BigDecimal bigDecimalFrom(BigDecimal otherTime, int timeScale)
          Deprecated. This is a draft API and might change in a future release of ICU.
static BigDecimal bigDecimalFrom(double otherTime, int timeScale)
          Deprecated. This is a draft API and might change in a future release of ICU.
static BigDecimal bigDecimalFrom(long otherTime, int timeScale)
          Deprecated. This is a draft API and might change in a future release of ICU.
static long from(long otherTime, int timeScale)
          Deprecated. This is a draft API and might change in a future release of ICU.
static long getTimeScaleValue(int scale, int value)
          Deprecated. This is a draft API and might change in a future release of ICU.
static BigDecimal toBigDecimal(BigDecimal universalTime, int timeScale)
          Deprecated. This is a draft API and might change in a future release of ICU.
static BigDecimal toBigDecimal(long universalTime, int timeScale)
          Deprecated. This is a draft API and might change in a future release of ICU.
static BigDecimal toBigDecimalTrunc(BigDecimal universalTime, int timeScale)
          Deprecated. Convert a time in the Universal Time Scale into another time scale.
static long toLong(long universalTime, int timeScale)
          Deprecated. This is a draft API and might change in a future release of ICU.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

JAVA_TIME

public static final int JAVA_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in the JDK. Data is a long. Value is milliseconds since January 1, 1970.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

UNIX_TIME

public static final int UNIX_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in Unix systems. Data is an int> or a long. Value is seconds since January 1, 1970.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

ICU4C_TIME

public static final int ICU4C_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in the ICU4C. Data is a double. Value is milliseconds since January 1, 1970.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

WINDOWS_FILE_TIME

public static final int WINDOWS_FILE_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in Windows for file times. Data is a long. Value is ticks (1 tick == 100 nanoseconds) since January 1, 1601.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

WINDOWS_DATE_TIME

public static final int WINDOWS_DATE_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in Windows for date time (?). Data is a long. Value is ticks (1 tick == 100 nanoseconds) since January 1, 0001.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

MAC_OLD_TIME

public static final int MAC_OLD_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in older Macintosh systems. Data is an int. Value is seconds since January 1, 1904.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

MAC_TIME

public static final int MAC_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in the JDK. Data is a double. Value is milliseconds since January 1, 2001.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

EXCEL_TIME

public static final int EXCEL_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in Excel. Data is a ?unknown?. Value is days since December 31, 1899.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

DB2_TIME

public static final int DB2_TIME
Deprecated. This is a draft API and might change in a future release of ICU.

Used in DB2. Data is a ?unknown?. Value is days since December 31, 1899.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

MAX_SCALE

public static final int MAX_SCALE
Deprecated. This is a draft API and might change in a future release of ICU.

This is the first unused time scale value.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

UNITS_VALUE

public static final int UNITS_VALUE
Deprecated. This is a draft API and might change in a future release of ICU.

The constant used to select the units value for a time scale.

See Also:
Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

EPOCH_OFFSET_VALUE

public static final int EPOCH_OFFSET_VALUE
Deprecated. This is a draft API and might change in a future release of ICU.

The constant used to select the epoch offset value for a time scale.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

FROM_MIN_VALUE

public static final int FROM_MIN_VALUE
Deprecated. This is a draft API and might change in a future release of ICU.

The constant used to select the minimum from value for a time scale.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

FROM_MAX_VALUE

public static final int FROM_MAX_VALUE
Deprecated. This is a draft API and might change in a future release of ICU.

The constant used to select the maximum from value for a time scale.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

TO_MIN_VALUE

public static final int TO_MIN_VALUE
Deprecated. This is a draft API and might change in a future release of ICU.

The constant used to select the minimum to value for a time scale.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

TO_MAX_VALUE

public static final int TO_MAX_VALUE
Deprecated. This is a draft API and might change in a future release of ICU.

The constant used to select the maximum to value for a time scale.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

EPOCH_OFFSET_PLUS_1_VALUE

public static final int EPOCH_OFFSET_PLUS_1_VALUE
Deprecated. This is a draft API and might change in a future release of ICU.

The constant used to select the epoch plus one value for a time scale. NOTE: This is an internal value. DO NOT USE IT. May not actually be equal to the epoch offset value plus one.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

EPOCH_OFFSET_MINUS_1_VALUE

public static final int EPOCH_OFFSET_MINUS_1_VALUE
Deprecated. 
The constant used to select the epoch offset minus one value for a time scale. NOTE: This is an internal value. DO NOT USE IT. May not actually be equal to the epoch offset value minus one.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Internal. This API is Internal Only and can change at any time.

UNITS_ROUND_VALUE

public static final int UNITS_ROUND_VALUE
Deprecated. 
The constant used to select the units round value for a time scale. NOTE: This is an internal value. DO NOT USE IT.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Internal. This API is Internal Only and can change at any time.

MIN_ROUND_VALUE

public static final int MIN_ROUND_VALUE
Deprecated. 
The constant used to select the minimum safe rounding value for a time scale. NOTE: This is an internal value. DO NOT USE IT.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Internal. This API is Internal Only and can change at any time.

MAX_ROUND_VALUE

public static final int MAX_ROUND_VALUE
Deprecated. 
The constant used to select the maximum safe rounding value for a time scale. NOTE: This is an internal value. DO NOT USE IT.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Internal. This API is Internal Only and can change at any time.

MAX_SCALE_VALUE

public static final int MAX_SCALE_VALUE
Deprecated. 
The number of time scale values. NOTE: This is an internal value. DO NOT USE IT.

See Also:
getTimeScaleValue(int, int), Constant Field Values
Status:
Internal. This API is Internal Only and can change at any time.
Method Detail

from

public static long from(long otherTime,
                        int timeScale)
Deprecated. This is a draft API and might change in a future release of ICU.

Convert a long datetime from the given time scale to the universal time scale.

Parameters:
otherTime - The long datetime
timeScale - The time scale to convert from
Returns:
The datetime converted to the universal time scale
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

bigDecimalFrom

public static BigDecimal bigDecimalFrom(double otherTime,
                                        int timeScale)
Deprecated. This is a draft API and might change in a future release of ICU.

Convert a double datetime from the given time scale to the universal time scale. All calculations are done using BigDecimal to guarantee that the value does not go out of range.

Parameters:
otherTime - The double datetime
timeScale - The time scale to convert from
Returns:
The datetime converted to the universal time scale
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

bigDecimalFrom

public static BigDecimal bigDecimalFrom(long otherTime,
                                        int timeScale)
Deprecated. This is a draft API and might change in a future release of ICU.

Convert a long datetime from the given time scale to the universal time scale. All calculations are done using BigDecimal to guarantee that the value does not go out of range.

Parameters:
otherTime - The long datetime
timeScale - The time scale to convert from
Returns:
The datetime converted to the universal time scale
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

bigDecimalFrom

public static BigDecimal bigDecimalFrom(BigDecimal otherTime,
                                        int timeScale)
Deprecated. This is a draft API and might change in a future release of ICU.

Convert a BigDecimal datetime from the given time scale to the universal time scale. All calculations are done using BigDecimal to guarantee that the value does not go out of range.

Parameters:
otherTime - The BigDecimal datetime
timeScale - The time scale to convert from
Returns:
The datetime converted to the universal time scale
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

toLong

public static long toLong(long universalTime,
                          int timeScale)
Deprecated. This is a draft API and might change in a future release of ICU.

Convert a datetime from the universal time scale stored as a BigDecimal to a long in the given time scale. Since this calculation requires a divide, we must round. The straight forward way to round by adding half of the divisor will push the sum out of range for values within have the divisor of the limits of the precision of a long. To get around this, we do the rounding like this:

(universalTime - units + units/2) / units + 1

(i.e. we subtract units first to guarantee that we'll still be in range when we add units/2. We then need to add one to the quotent to make up for the extra subtraction. This simplifies to:

(universalTime - units/2) / units - 1

For negative values to round away from zero, we need to flip the signs:

(universalTime + units/2) / units + 1

Since we also need to subtract the epochOffset, we fold the +/- 1 into the offset value. (i.e. epochOffsetP1, epochOffsetM1.)

Parameters:
universalTime - The datetime in the universal time scale
timeScale - The time scale to convert to
Returns:
The datetime converted to the given time scale
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

toBigDecimal

public static BigDecimal toBigDecimal(long universalTime,
                                      int timeScale)
Deprecated. This is a draft API and might change in a future release of ICU.

Convert a datetime from the universal time scale to a BigDecimal in the given time scale.

Parameters:
universalTime - The datetime in the universal time scale
timeScale - The time scale to convert to
Returns:
The datetime converted to the given time scale
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

toBigDecimal

public static BigDecimal toBigDecimal(BigDecimal universalTime,
                                      int timeScale)
Deprecated. This is a draft API and might change in a future release of ICU.

Convert a datetime from the universal time scale to a BigDecimal in the given time scale.

Parameters:
universalTime - The datetime in the universal time scale
timeScale - The time scale to convert to
Returns:
The datetime converted to the given time scale
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

getTimeScaleValue

public static long getTimeScaleValue(int scale,
                                     int value)
Deprecated. This is a draft API and might change in a future release of ICU.

Get a value associated with a particular time scale.

Parameters:
scale - - the time scale
value - - a constant representing the value to get
Returns:
- the value.
Status:
Draft ICU 3.2.
Status:
Deprecated in This is a draft API and might change in a future release of ICU..

toBigDecimalTrunc

public static BigDecimal toBigDecimalTrunc(BigDecimal universalTime,
                                           int timeScale)
Deprecated. 
Convert a time in the Universal Time Scale into another time scale. The division used to do the conversion rounds down. NOTE: This is an internal routine used by the tool that generates the to and from limits. Use it at your own risk.

Parameters:
universalTime - the time in the Universal Time scale
timeScale - the time scale to convert to
Returns:
the time in the given time scale
Status:
Internal. This API is Internal Only and can change at any time.


Copyright (c) 2004 IBM Corporation and others.