gnu.java.util

Class ZoneInfo

Implemented Interfaces:
Cloneable, Serializable

public class ZoneInfo
extends TimeZone

This class represents more advanced variant of java.util.SimpleTimeZone. It can handle zic(8) compiled transition dates plus uses a SimpleTimeZone for years beyond last precomputed transition. Before first precomputed transition it assumes no daylight saving was in effect. Timezones that never used daylight saving time should use just SimpleTimeZone instead of this class. This object is tightly bound to the Gregorian calendar. It assumes a regular seven days week, and the month lengths are that of the Gregorian Calendar.
See Also:
Calendar, GregorianCalendar, SimpleTimeZone, Serialized Form

Field Summary

Fields inherited from class java.util.TimeZone

LONG, SHORT

Constructor Summary

ZoneInfo(int rawOffset, String id, long[] transitions, SimpleTimeZone lastRule)
Create a ZoneInfo with the given time offset from GMT and with daylight savings.

Method Summary

boolean
equals(Object o)
Determine whether this Object is semantically equal to another Object.
int
getDSTSavings()
Gets the daylight savings offset.
int
getOffset(int era, int year, int month, int day, int dayOfWeek, int millis)
Gets the time zone offset, for current date, modified in case of daylight savings.
int
getOffset(long date)
Get the time zone offset for the specified date, modified in case of daylight savings.
int
getRawOffset()
Returns the time zone offset to GMT in milliseconds, ignoring day light savings.
boolean
hasSameRules(TimeZone o)
Test if the other time zone uses the same rule and only possibly differs in ID.
int
hashCode()
Generates the hashCode for the SimpleDateFormat object.
boolean
inDaylightTime(Date date)
Determines if the given date is in daylight savings time.
static TimeZone
readTZFile(String id, String file)
Reads zic(8) compiled timezone data file from file and returns a TimeZone class describing it, either SimpleTimeZone or ZoneInfo depending on whether it can be described by SimpleTimeZone rule or not.
void
setRawOffset(int rawOffset)
Sets the standard time zone offset to GMT.
String
toString()
Returns a string representation of this ZoneInfo object.
boolean
useDaylightTime()
Returns if this time zone uses daylight savings time.

Methods inherited from class java.util.TimeZone

clone, getAvailableIDs, getAvailableIDs, getDSTSavings, getDefault, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getID, getOffset, getOffset, getRawOffset, getTimeZone, hasSameRules, inDaylightTime, setDefault, setID, setRawOffset, useDaylightTime

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ZoneInfo

public ZoneInfo(int rawOffset,
                String id,
                long[] transitions,
                SimpleTimeZone lastRule)
Create a ZoneInfo with the given time offset from GMT and with daylight savings.
Parameters:
rawOffset - The time offset from GMT in milliseconds.
id - The identifier of this time zone.
transitions - Array of transition times in UTC seconds since Epoch in topmost 42 bits, below that 1 boolean bit whether the time before that transition used daylight saving and in bottommost 21 bits relative daylight saving offset against rawOffset in seconds that applies before this transition.

Method Details

equals

public boolean equals(Object o)
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in interface Object
Parameters:
Returns:
whether this Object is semantically equal to another

getDSTSavings

public int getDSTSavings()
Gets the daylight savings offset. This is a positive offset in milliseconds with respect to standard time. Typically this is one hour, but for some time zones this may be half an our.
Overrides:
getDSTSavings in interface TimeZone
Returns:
the daylight savings offset in milliseconds.

getOffset

public int getOffset(int era,
                     int year,
                     int month,
                     int day,
                     int dayOfWeek,
                     int millis)
Gets the time zone offset, for current date, modified in case of daylight savings. This is the offset to add to UTC to get the local time. The day must be a positive number and dayOfWeek must be a positive value from Calendar. dayOfWeek is redundant, but must match the other values or an inaccurate result may be returned.
Overrides:
getOffset in interface TimeZone
Parameters:
era - the era of the given date
year - the year of the given date
month - the month of the given date, 0 for January.
day - the day of month
dayOfWeek - the day of week; this must match the other fields.
millis - the millis in the day (in local standard time)
Returns:
the time zone offset in milliseconds.
Throws:
IllegalArgumentException - if arguments are incorrect.

getOffset

public int getOffset(long date)
Get the time zone offset for the specified date, modified in case of daylight savings. This is the offset to add to UTC to get the local time.
Overrides:
getOffset in interface TimeZone
Parameters:
date - the date represented in millisecends since January 1, 1970 00:00:00 GMT.

getRawOffset

public int getRawOffset()
Returns the time zone offset to GMT in milliseconds, ignoring day light savings.
Overrides:
getRawOffset in interface TimeZone
Returns:
the time zone offset.

hasSameRules

public boolean hasSameRules(TimeZone o)
Test if the other time zone uses the same rule and only possibly differs in ID. This implementation for this particular class will return true if the other object is a ZoneInfo, the raw offsets and useDaylight are identical and if useDaylight is true, also the start and end datas are identical.
Overrides:
hasSameRules in interface TimeZone
Returns:
true if this zone uses the same rule.

hashCode

public int hashCode()
Generates the hashCode for the SimpleDateFormat object. It is the rawOffset, possibly, if useDaylightSavings is true, xored with startYear, startMonth, startDayOfWeekInMonth, ..., endTime.
Overrides:
hashCode in interface Object

inDaylightTime

public boolean inDaylightTime(Date date)
Determines if the given date is in daylight savings time.
Overrides:
inDaylightTime in interface TimeZone
Returns:
true, if it is in daylight savings time, false otherwise.

readTZFile

public static TimeZone readTZFile(String id,
                                  String file)
Reads zic(8) compiled timezone data file from file and returns a TimeZone class describing it, either SimpleTimeZone or ZoneInfo depending on whether it can be described by SimpleTimeZone rule or not.

setRawOffset

public void setRawOffset(int rawOffset)
Sets the standard time zone offset to GMT.
Overrides:
setRawOffset in interface TimeZone
Parameters:
rawOffset - The time offset from GMT in milliseconds.

toString

public String toString()
Returns a string representation of this ZoneInfo object.
Overrides:
toString in interface Object
Returns:
a string representation of this ZoneInfo object.

useDaylightTime

public boolean useDaylightTime()
Returns if this time zone uses daylight savings time.
Overrides:
useDaylightTime in interface TimeZone
Returns:
true, if we use daylight savings time, false otherwise.

gnu.java.util.ZoneInfo Copyright (C) 2007 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.