All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.util.TimeZone

java.lang.Object
   |
   +----java.util.TimeZone

public class TimeZone
extends Object
implements Serializable, Cloneable
TimeZone represents a time zone offset, and also figures out daylight savings.

Typically, you get a TimeZone using getDefault which creates a TimeZone based on the time zone where the program is running. For example, for a program running in Japan, getDefault creates a TimeZone object based on Japanese Standard Time.

You can also get a TimeZone using getTimeZone along with a time zone ID. For instance, the time zone ID for the Pacific Standard Time zone is "PST". So, you can get a PST TimeZone object with:

 TimeZone tz = TimeZone.getTimeZone("PST");
 
You can use getAvailableIDs method to iterate through all the supported time zone IDs. You can then choose a supported ID to get a favorite TimeZone.

See Also:
Calendar, GregorianCalendar, SimpleTimeZone

Constructor Index

 o TimeZone()

Method Index

 o clone()
Overrides Cloneable
 o getAvailableIDs()
Gets all the available IDs supported.
 o getAvailableIDs(int)
Gets the available IDs according to the given time zone offset.
 o getDefault()
Gets the default TimeZone for this host.
 o getID()
Gets the ID of this time zone.
 o getOffset(int, int, int, int, int, int)
Gets the time zone offset, for current date, modified in case of daylight savings.
 o getRawOffset()
Gets unmodified offset, NOT modified in case of daylight savings.
 o getTimeZone(String)
Gets the TimeZone for the given ID.
 o inDaylightTime(Date)
Queries if the given date is in Daylight Savings Time in this time zone.
 o setDefault(TimeZone)
Sets time zone to using the given TimeZone.
 o setID(String)
Sets the time zone ID.
 o setRawOffset(int)
Sets the base time zone offset to GMT.
 o useDaylightTime()
Queries if this time zone uses Daylight Savings Time.

Constructors

 o TimeZone
    method TimeZone() public 

Methods

 o getOffset
    method getOffset(era=int, -
                     year=int, -
                     month=int, -
                     day=int, -
                     dayOfWeek=int, -
                     milliseconds=int) returns int public abstract    
Gets the time zone offset, for current date, modified in case of daylight savings. This is the offset to add *to* UTC to get local time.

Parameters:
era - the era of the given date.
year - the year in the given date.
month - the month in the given date. Month is 0-based. e.g., 0 for January.
day - the day-in-month of the given date.
dayOfWeek - the day-of-week of the given date.
milliseconds - the millis in day.
Returns:
the offset to add *to* GMT to get local time.
 o setRawOffset
    method setRawOffset(offsetMillis=int)  public abstract    
Sets the base time zone offset to GMT. This is the offset to add *to* UTC to get local time.

Parameters:
offsetMillis - the given base time zone offset to GMT.
 o getRawOffset
    method getRawOffset() returns int public abstract    
Gets unmodified offset, NOT modified in case of daylight savings. This is the offset to add *to* UTC to get local time.

Returns:
the unmodified offset to add *to* UTC to get local time.
 o getID
    method getID() returns String public     
Gets the ID of this time zone.

Returns:
the ID of this time zone.
 o setID
    method setID(ID=String)  public     
Sets the time zone ID. This does not change any other data in the time zone object.

Parameters:
ID - the new time zone ID.
 o useDaylightTime
    method useDaylightTime() returns boolean public abstract    
Queries if this time zone uses Daylight Savings Time.

Returns:
true if this time zone uses Daylight Savings Time, false, otherwise.
 o inDaylightTime
    method inDaylightTime(date=Date) returns boolean public abstract    
Queries if the given date is in Daylight Savings Time in this time zone.

Parameters:
date - the given Date.
Returns:
true if the given date is in Daylight Savings Time, false, otherwise.
 o getTimeZone
    method getTimeZone(ID=String) returns TimeZone public  static  protect 
Gets the TimeZone for the given ID.

Parameters:
ID - the given ID.
Returns:
a TimeZone.
 o getAvailableIDs
    method getAvailableIDs(rawOffset=int) returns String[] public  static  protect 
Gets the available IDs according to the given time zone offset.

Parameters:
rawOffset - the given time zone GMT offset.
Returns:
an array of IDs, where the time zone for that ID has the specified GMT offset. For example, {"Phoenix", "Denver"}, since both have GMT-07:00, but differ in daylight savings behavior.
 o getAvailableIDs
    method getAvailableIDs() returns String[] public  static  protect 
Gets all the available IDs supported.

Returns:
an array of IDs.
 o getDefault
    method getDefault() returns TimeZone public  static  protect 
Gets the default TimeZone for this host.

Returns:
a default TimeZone.
 o setDefault
    method setDefault(zone=TimeZone)  public  static  protect 
Sets time zone to using the given TimeZone.

Parameters:
zone - the given time zone.
 o clone
    method clone() returns Object public     
Overrides Cloneable

Overrides:
clone in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index