Java Doc for TimeZone.java in  » 6.0-JDK-Core » Collections-Jar-Zip-Logging-regex » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Collections Jar Zip Logging regex » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.TimeZone

All known Subclasses:   java.util.SimpleTimeZone,
TimeZone
abstract public class TimeZone implements Serializable,Cloneable(Code)
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 U.S. Pacific Time zone is "America/Los_Angeles". So, you can get a U.S. Pacific Time TimeZone object with:

 TimeZone tz = TimeZone.getTimeZone("America/Los_Angeles");
 
You can use the getAvailableIDs method to iterate through all the supported time zone IDs. You can then choose a supported ID to get a TimeZone. If the time zone you want is not represented by one of the supported IDs, then a custom time zone ID can be specified to produce a TimeZone. The syntax of a custom time zone ID is:
 CustomID:
 GMT Sign Hours : Minutes
 GMT Sign Hours Minutes
 GMT Sign Hours
 Sign: one of
 + -
 Hours:
 Digit
 Digit Digit
 Minutes:
 Digit Digit
 Digit: one of
 0 1 2 3 4 5 6 7 8 9
 
Hours must be between 0 to 23 and Minutes must be between 00 to 59. For example, "GMT+10" and "GMT+0010" mean ten hours and ten minutes ahead of GMT, respectively.

The format is locale independent and digits must be taken from the Basic Latin block of the Unicode standard. No daylight saving time transition schedule can be specified with a custom time zone ID. If the specified string doesn't match the syntax, "GMT" is used.

When creating a TimeZone, the specified custom time zone ID is normalized in the following syntax:

 NormalizedCustomID:
 GMT Sign TwoDigitHours : Minutes
 Sign: one of
 + -
 TwoDigitHours:
 Digit Digit
 Minutes:
 Digit Digit
 Digit: one of
 0 1 2 3 4 5 6 7 8 9
 
For example, TimeZone.getTimeZone("GMT-8").getID() returns "GMT-08:00".

Three-letter time zone IDs

For compatibility with JDK 1.1.x, some other three-letter time zone IDs (such as "PST", "CTT", "AST") are also supported. However, their use is deprecated because the same abbreviation is often used for multiple time zones (for example, "CST" could be U.S. "Central Standard Time" and "China Standard Time"), and the Java platform can then only recognize one of them.
See Also:   Calendar
See Also:   GregorianCalendar
See Also:   SimpleTimeZone
version:
   1.81 05/05/07
author:
   Mark Davis, David Goldsmith, Chen-Lieh Huang, Alan Liu
since:
   JDK1.1


Field Summary
final static  StringGMT_ID
    
final public static  intLONG
    
final static  TimeZoneNO_TIMEZONE
     The null constant as a TimeZone.
final public static  intSHORT
    
final static  longserialVersionUID
    

Constructor Summary
public  TimeZone()
     Sole constructor.

Method Summary
public  Objectclone()
     Creates a copy of this TimeZone.
public static synchronized  String[]getAvailableIDs(int rawOffset)
     Gets the available IDs according to the given time zone offset in milliseconds.
Parameters:
  rawOffset - the given time zone GMT offset in milliseconds.
public static synchronized  String[]getAvailableIDs()
     Gets all the available IDs supported.
public  intgetDSTSavings()
     Returns the amount of time to be added to local standard time to get local wall clock time.

The default implementation always returns 3600000 milliseconds (i.e., one hour) if this time zone observes Daylight Saving Time.

public static  TimeZonegetDefault()
     Gets the default TimeZone for this host.
static  TimeZonegetDefaultRef()
     Returns the reference to the default TimeZone object.
final public  StringgetDisplayName()
     Returns a name of this time zone suitable for presentation to the user in the default locale.
final public  StringgetDisplayName(Locale locale)
     Returns a name of this time zone suitable for presentation to the user in the specified locale. This method returns the long name, not including daylight savings. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format.
Parameters:
  locale - the locale in which to supply the display name.
final public  StringgetDisplayName(boolean daylight, int style)
     Returns a name of this time zone suitable for presentation to the user in the default locale.
public  StringgetDisplayName(boolean daylight, int style, Locale locale)
     Returns a name of this time zone suitable for presentation to the user in the specified locale. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format.
Parameters:
  daylight - if true, return the daylight savings name.
Parameters:
  style - either LONG or SHORT
Parameters:
  locale - the locale in which to supply the display name.
public  StringgetID()
     Gets the ID of this time zone.
abstract public  intgetOffset(int era, int year, int month, int day, int dayOfWeek, int milliseconds)
     Gets the time zone offset, for current date, modified in case of daylight savings.
public  intgetOffset(long date)
     Returns the offset of this time zone from UTC at the specified date.
 intgetOffsets(long date, int[] offsets)
     Gets the raw GMT offset and the amount of daylight saving of this time zone at the given time.
Parameters:
  date - the milliseconds (since January 1, 1970,00:00:00.000 GMT) at which the time zone offset and daylightsaving amount are found
Parameters:
  offset - an array of int where the raw GMT offset(offset[0]) and daylight saving amount (offset[1]) are stored,or null if those values are not needed.
abstract public  intgetRawOffset()
     Returns the amount of time in milliseconds to add to UTC to get standard time in this time zone.
public static synchronized  TimeZonegetTimeZone(String ID)
     Gets the TimeZone for the given ID.
Parameters:
  ID - the ID for a TimeZone, either an abbreviationsuch as "PST", a full name such as "America/Los_Angeles", or a customID such as "GMT-8:00".
public  booleanhasSameRules(TimeZone other)
     Returns true if this zone has the same rule and offset as another zone. That is, if this zone differs only in ID, if at all.
abstract public  booleaninDaylightTime(Date date)
     Queries if the given date is in daylight savings time in this time zone.
Parameters:
  date - the given Date.
public static  voidsetDefault(TimeZone zone)
     Sets the TimeZone that is returned by the getDefault method.
public  voidsetID(String ID)
     Sets the time zone ID.
abstract public  voidsetRawOffset(int offsetMillis)
     Sets the base time zone offset to GMT.
abstract public  booleanuseDaylightTime()
     Queries if this time zone uses daylight savings time.

Field Detail
GMT_ID
final static String GMT_ID(Code)



LONG
final public static int LONG(Code)
A style specifier for getDisplayName() indicating a long name, such as "Pacific Standard Time."
See Also:   TimeZone.SHORT
since:
   1.2



NO_TIMEZONE
final static TimeZone NO_TIMEZONE(Code)
The null constant as a TimeZone.



SHORT
final public static int SHORT(Code)
A style specifier for getDisplayName() indicating a short name, such as "PST."
See Also:   TimeZone.LONG
since:
   1.2



serialVersionUID
final static long serialVersionUID(Code)




Constructor Detail
TimeZone
public TimeZone()(Code)
Sole constructor. (For invocation by subclass constructors, typically implicit.)




Method Detail
clone
public Object clone()(Code)
Creates a copy of this TimeZone. a clone of this TimeZone



getAvailableIDs
public static synchronized String[] getAvailableIDs(int rawOffset)(Code)
Gets the available IDs according to the given time zone offset in milliseconds.
Parameters:
  rawOffset - the given time zone GMT offset in milliseconds. an array of IDs, where the time zone for that ID hasthe specified GMT offset. For example, "America/Phoenix" and "America/Denver"both have GMT-07:00, but differ in daylight savings behavior.
See Also:   TimeZone.getRawOffset()



getAvailableIDs
public static synchronized String[] getAvailableIDs()(Code)
Gets all the available IDs supported. an array of IDs.



getDSTSavings
public int getDSTSavings()(Code)
Returns the amount of time to be added to local standard time to get local wall clock time.

The default implementation always returns 3600000 milliseconds (i.e., one hour) if this time zone observes Daylight Saving Time. Otherwise, 0 (zero) is returned.

If an underlying TimeZone implementation subclass supports historical Daylight Saving Time changes, this method returns the known latest daylight saving value. the amount of saving time in milliseconds
since:
   1.4




getDefault
public static TimeZone getDefault()(Code)
Gets the default TimeZone for this host. The source of the default TimeZone may vary with implementation. a default TimeZone.
See Also:   TimeZone.setDefault



getDefaultRef
static TimeZone getDefaultRef()(Code)
Returns the reference to the default TimeZone object. This method doesn't create a clone.



getDisplayName
final public String getDisplayName()(Code)
Returns a name of this time zone suitable for presentation to the user in the default locale. This method returns the long name, not including daylight savings. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format. the human-readable name of this time zone in the default locale.
since:
   1.2



getDisplayName
final public String getDisplayName(Locale locale)(Code)
Returns a name of this time zone suitable for presentation to the user in the specified locale. This method returns the long name, not including daylight savings. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format.
Parameters:
  locale - the locale in which to supply the display name. the human-readable name of this time zone in the given locale.
since:
   1.2



getDisplayName
final public String getDisplayName(boolean daylight, int style)(Code)
Returns a name of this time zone suitable for presentation to the user in the default locale. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format.
Parameters:
  daylight - if true, return the daylight savings name.
Parameters:
  style - either LONG or SHORT the human-readable name of this time zone in the default locale.
since:
   1.2



getDisplayName
public String getDisplayName(boolean daylight, int style, Locale locale)(Code)
Returns a name of this time zone suitable for presentation to the user in the specified locale. If the display name is not available for the locale, then this method returns a string in the normalized custom ID format.
Parameters:
  daylight - if true, return the daylight savings name.
Parameters:
  style - either LONG or SHORT
Parameters:
  locale - the locale in which to supply the display name. the human-readable name of this time zone in the given locale.
exception:
  IllegalArgumentException - style is invalid.
since:
   1.2



getID
public String getID()(Code)
Gets the ID of this time zone. the ID of this time zone.



getOffset
abstract public int getOffset(int era, int year, int month, int day, int dayOfWeek, int milliseconds)(Code)
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.

This method returns a historically correct offset if an underlying TimeZone implementation subclass supports historical Daylight Saving Time schedule and GMT offset changes.
Parameters:
  era - the era of the given date.
Parameters:
  year - the year in the given date.
Parameters:
  month - the month in the given date.Month is 0-based. e.g., 0 for January.
Parameters:
  day - the day-in-month of the given date.
Parameters:
  dayOfWeek - the day-of-week of the given date.
Parameters:
  milliseconds - the milliseconds in day in standardlocal time. the offset in milliseconds to add to GMT to get local time.
See Also:   Calendar.ZONE_OFFSET
See Also:   Calendar.DST_OFFSET




getOffset
public int getOffset(long date)(Code)
Returns the offset of this time zone from UTC at the specified date. If Daylight Saving Time is in effect at the specified date, the offset value is adjusted with the amount of daylight saving.

This method returns a historically correct offset value if an underlying TimeZone implementation subclass supports historical Daylight Saving Time schedule and GMT offset changes.
Parameters:
  date - the date represented in milliseconds since January 1, 1970 00:00:00 GMT the amount of time in milliseconds to add to UTC to get local time.
See Also:   Calendar.ZONE_OFFSET
See Also:   Calendar.DST_OFFSET
since:
   1.4




getOffsets
int getOffsets(long date, int[] offsets)(Code)
Gets the raw GMT offset and the amount of daylight saving of this time zone at the given time.
Parameters:
  date - the milliseconds (since January 1, 1970,00:00:00.000 GMT) at which the time zone offset and daylightsaving amount are found
Parameters:
  offset - an array of int where the raw GMT offset(offset[0]) and daylight saving amount (offset[1]) are stored,or null if those values are not needed. The method assumes thatthe length of the given array is two or larger. the total amount of the raw GMT offset and daylightsaving at the specified date.
See Also:   Calendar.ZONE_OFFSET
See Also:   Calendar.DST_OFFSET



getRawOffset
abstract public int getRawOffset()(Code)
Returns the amount of time in milliseconds to add to UTC to get standard time in this time zone. Because this value is not affected by daylight saving time, it is called raw offset.

If an underlying TimeZone implementation subclass supports historical GMT offset changes, the method returns the raw offset value of the current date. In Honolulu, for example, its raw offset changed from GMT-10:30 to GMT-10:00 in 1947, and this method always returns -36000000 milliseconds (i.e., -10 hours). the amount of raw offset time in milliseconds to add to UTC.
See Also:   Calendar.ZONE_OFFSET




getTimeZone
public static synchronized TimeZone getTimeZone(String ID)(Code)
Gets the TimeZone for the given ID.
Parameters:
  ID - the ID for a TimeZone, either an abbreviationsuch as "PST", a full name such as "America/Los_Angeles", or a customID such as "GMT-8:00". Note that the support of abbreviations isfor JDK 1.1.x compatibility only and full names should be used. the specified TimeZone, or the GMT zone if the given IDcannot be understood.



hasSameRules
public boolean hasSameRules(TimeZone other)(Code)
Returns true if this zone has the same rule and offset as another zone. That is, if this zone differs only in ID, if at all. Returns false if the other zone is null.
Parameters:
  other - the TimeZone object to be compared with true if the other zone is not null and is the same as this one,with the possible exception of the ID
since:
   1.2



inDaylightTime
abstract public boolean inDaylightTime(Date date)(Code)
Queries if the given date is in daylight savings time in this time zone.
Parameters:
  date - the given Date. true if the given date is in daylight savings time,false, otherwise.



setDefault
public static void setDefault(TimeZone zone)(Code)
Sets the TimeZone that is returned by the getDefault method. If zone is null, reset the default to the value it had originally when the VM first started.
Parameters:
  zone - the new default time zone
See Also:   TimeZone.getDefault



setID
public void setID(String ID)(Code)
Sets the time zone ID. This does not change any other data in the time zone object.
Parameters:
  ID - the new time zone ID.



setRawOffset
abstract public void setRawOffset(int offsetMillis)(Code)
Sets the base time zone offset to GMT. This is the offset to add to UTC to get local time.

If an underlying TimeZone implementation subclass supports historical GMT offset changes, the specified GMT offset is set as the latest GMT offset and the difference from the known latest GMT offset value is used to adjust all historical GMT offset values.
Parameters:
  offsetMillis - the given base time zone offset to GMT.




useDaylightTime
abstract public boolean useDaylightTime()(Code)
Queries if this time zone uses daylight savings time.

If an underlying TimeZone implementation subclass supports historical Daylight Saving Time schedule changes, the method refers to the latest Daylight Saving Time schedule information. true if this time zone uses daylight savings time,false, otherwise.




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.