FileDocCategorySizeDatePackage
TimeZone.javaAPI DocJ2ME CLDC 1.16415Wed Feb 05 15:56:00 GMT 2003java.util

TimeZone

public abstract class TimeZone extends Object
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");

This class is a pure subset of the java.util.TimeZone class in JDK 1.3.

The only time zone ID that is required to be supported is "GMT".

Apart from the methods and variables being subset, the semantics of the getTimeZone() method may also be subset: custom IDs such as "GMT-8:00" are not required to be supported.

see
java.util.Calendar
see
java.util.Date
version
CLDC 1.1 02/01/2002 (Based on JDK 1.3)
author
Mark Davis, David Goldsmith, Chen-Lieh Huang, Alan Liu
author
Brian Modra, Kinsley Wong

Fields Summary
private static com.sun.cldc.util.j2me.TimeZoneImpl
defaultZone
private static String
platform
private static String
classRoot
Constructors Summary
public TimeZone()


      
    
Methods Summary
public static java.lang.String[]getAvailableIDs()
Gets all the available IDs supported.

return
an array of IDs.

        getDefault();
        return defaultZone.getIDs();
    
public static synchronized java.util.TimeZonegetDefault()
Gets the default TimeZone for this host. The source of the default TimeZone may vary with implementation.

return
a default TimeZone.

        if ( defaultZone == null ) {
            try {
                Class clazz = Class.forName("com.sun.cldc.util.j2me.TimeZoneImpl");

                // Construct a new TimeZoneImpl instance
                defaultZone = (TimeZoneImpl)clazz.newInstance();
                defaultZone = (TimeZoneImpl)defaultZone.getInstance(null);
            }
            catch (Exception x) {}
        }
        return defaultZone;
    
public java.lang.StringgetID()
Gets the ID of this time zone.

return
the ID of this time zone.

        return null;
    
public abstract intgetOffset(int era, int year, int month, int day, int dayOfWeek, int millis)
Gets offset, for current date, modified in case of daylight savings. This is the offset to add *to* GMT to get local time. Gets the time zone offset, for current date, modified in case of daylight savings. This is the offset to add *to* GMT to get local time. Assume that the start and end month are distinct. This method may return incorrect results for rules that start at the end of February (e.g., last Sunday in February) or the beginning of March (e.g., March 1).

param
era The era of the given date (0 = BC, 1 = AD).
param
year The year in the given date.
param
month The month in the given date. Month is 0-based. e.g., 0 for January.
param
day The day-in-month of the given date.
param
dayOfWeek The day-of-week of the given date.
param
millis The milliseconds in day in standard local time.
return
The offset to add *to* GMT to get local time.
exception
IllegalArgumentException the era, month, day, dayOfWeek, or millis parameters are out of range

public abstract intgetRawOffset()
Gets the GMT offset for this time zone.

return
the GMT offset for this time zone.

public static synchronized java.util.TimeZonegetTimeZone(java.lang.String ID)
Gets the TimeZone for the given ID.

param
ID the ID for a TimeZone, either an abbreviation such as "GMT", or a full name such as "America/Los_Angeles".

The only time zone ID that is required to be supported is "GMT".

return
the specified TimeZone, or the GMT zone if the given ID cannot be understood.

        if (ID == null) {
            throw new NullPointerException();
        }
        getDefault();
        TimeZone tz = defaultZone.getInstance(ID);
        if (tz == null) {
            tz = defaultZone.getInstance("GMT");
        }
        return tz;
    
public abstract booleanuseDaylightTime()
Queries if this time zone uses Daylight Savings Time.

return
if this time zone uses Daylight Savings Time.