public class RuleBasedTimeZone extends BasicTimeZone
RuleBasedTimeZone is a concrete subclass of TimeZone that allows users to define
custom historic time transition rules.TimeZoneRule,
Serialized FormTimeZone.SystemTimeZoneTypeFORMER_LATTER_MASK, LOCAL_DST, LOCAL_FORMER, LOCAL_LATTER, LOCAL_STD, STD_DST_MASKGENERIC_LOCATION, GMT_ZONE, LONG, LONG_GENERIC, LONG_GMT, SHORT, SHORT_COMMONLY_USED, SHORT_GENERIC, SHORT_GMT, TIMEZONE_ICU, TIMEZONE_JDK, UNKNOWN_ZONE, UNKNOWN_ZONE_ID| Constructor and Description |
|---|
RuleBasedTimeZone(java.lang.String id,
InitialTimeZoneRule initialRule)
Constructs a
RuleBasedTimeZone object with the ID and the
InitialTimeZoneRule |
| Modifier and Type | Method and Description |
|---|---|
void |
addTransitionRule(TimeZoneRule rule)
Adds the
TimeZoneRule which represents time transitions. |
java.lang.Object |
clone()
Overrides clone.
|
TimeZone |
cloneAsThawed()
Provides for the clone operation.
|
TimeZone |
freeze()
Freezes the object.
|
TimeZoneTransition |
getNextTransition(long base,
boolean inclusive)
[icu] Returns the first time zone transition after the base time.
|
int |
getOffset(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.
|
void |
getOffset(long time,
boolean local,
int[] offsets)
Returns the time zone raw and GMT offset for the given moment
in time.
|
void |
getOffsetFromLocal(long date,
int nonExistingTimeOpt,
int duplicatedTimeOpt,
int[] offsets)
Deprecated.
This API is ICU internal only.
|
TimeZoneTransition |
getPreviousTransition(long base,
boolean inclusive)
[icu] Returns the last time zone transition before the base time.
|
int |
getRawOffset()
Gets unmodified offset, NOT modified in case of daylight savings.
|
TimeZoneRule[] |
getTimeZoneRules()
[icu] Returns the array of
TimeZoneRule which represents the rule
of this time zone object. |
boolean |
hasSameRules(TimeZone other)
Returns true if this zone has the same rule and offset as another zone.
|
boolean |
inDaylightTime(java.util.Date date)
Queries if the given date is in daylight savings time in
this time zone.
|
boolean |
isFrozen()
Determines whether the object has been frozen or not.
|
boolean |
observesDaylightTime()
Queries if this time zone is in daylight saving time or will observe
daylight saving time at any future time.
|
void |
setRawOffset(int offsetMillis)
Sets the base time zone offset to GMT.
|
boolean |
useDaylightTime()
Queries if this time zone uses daylight savings time.
|
getSimpleTimeZoneRulesNear, getTimeZoneRules, hasEquivalentTransitions, hasEquivalentTransitionscountEquivalentIDs, equals, getAvailableIDs, getAvailableIDs, getAvailableIDs, getAvailableIDs, getCanonicalID, getCanonicalID, getDefault, getDefaultTimeZoneType, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getDSTSavings, getEquivalentID, getFrozenTimeZone, getID, getIDForWindowsID, getOffset, getRegion, getTimeZone, getTimeZone, getTZDataVersion, getWindowsID, hashCode, setDefault, setDefaultTimeZoneType, setICUDefault, setIDpublic RuleBasedTimeZone(java.lang.String id,
InitialTimeZoneRule initialRule)
RuleBasedTimeZone object with the ID and the
InitialTimeZoneRuleid - The time zone ID.initialRule - The initial time zone rule.public void addTransitionRule(TimeZoneRule rule)
TimeZoneRule which represents time transitions.
The TimeZoneRule must have start times, that is, the result
of TimeZoneRule.isTransitionRule() must be true.
Otherwise, IllegalArgumentException is thrown.rule - The TimeZoneRule.public int getOffset(int era,
int year,
int month,
int day,
int dayOfWeek,
int milliseconds)
getOffset in class TimeZoneera - 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 in standard local time.public void getOffset(long time,
boolean local,
int[] offsets)
getOffset in class TimeZonetime - moment in time for which to return offsets, in
units of milliseconds from January 1, 1970 0:00 GMT, either GMT
time or local wall time, depending on `local'.local - if true, `date' is local wall time; otherwise it
is in GMT time.offsets - output parameter to receive the raw offset, that
is, the offset not including DST adjustments, in offsets[0],
and the DST offset, that is, the offset to be added to
`rawOffset' to obtain the total offset between local and GMT
time, in offsets[1]. If DST is not in effect, the DST offset is
zero; otherwise it is a positive value, typically one hour.@Deprecated
public void getOffsetFromLocal(long date,
int nonExistingTimeOpt,
int duplicatedTimeOpt,
int[] offsets)
getOffsetFromLocal in class BasicTimeZonepublic int getRawOffset()
getRawOffset in class TimeZonepublic boolean inDaylightTime(java.util.Date date)
inDaylightTime in class TimeZonedate - the given Date.public void setRawOffset(int offsetMillis)
setRawOffset in class TimeZoneoffsetMillis - the given base time zone offset to GMT.public boolean useDaylightTime()
useDaylightTime in class TimeZoneNote:The default implementation of
ICU TimeZone uses the tz database, which supports historic
rule changes, for system time zones. With the implementation,
there are time zones that used daylight savings time in the
past, but no longer used currently. For example, Asia/Tokyo has
never used daylight savings time since 1951. Most clients would
expect that this method to return false for such case.
The default implementation of this method returns true
when the time zone uses daylight savings time in the current
(Gregorian) calendar year.
public boolean observesDaylightTime()
The default implementation in this class returns true if TimeZone.useDaylightTime()
or inDaylightTime(new Date()) returns true.
Note: This method was added for TimeZone compatibility
support. The TimeZone.useDaylightTime() method only checks the last known
rule(s), therefore it may return false even the zone observes daylight saving time currently.
TimeZone added observesDaylightTime() to resolve the issue.
In ICU, TimeZone.useDaylightTime() works differently. The ICU implementation checks if the
zone uses daylight saving time in the current calendar year. Therefore, it will never return
false if daylight saving time is currently used.
ICU's TimeZone subclass implementations override this method to support the same behavior
with TimeZone.observesDaylightTime(). Unlike TimeZone.useDaylightTime(),
the implementation does not take past daylight saving time into account, so
that this method may return false even when TimeZone.useDaylightTime() returns
true.
observesDaylightTime in class TimeZonetrue if this time zone is in daylight saving time or will observe
daylight saving time at any future time.TimeZone.useDaylightTime()public boolean hasSameRules(TimeZone other)
hasSameRules in class TimeZoneother - the TimeZone object to be compared withpublic TimeZoneRule[] getTimeZoneRules()
TimeZoneRule which represents the rule
of this time zone object. The first element in the result array will
be the InitialTimeZoneRule instance for the initial rule.
The rest will be either AnnualTimeZoneRule or
TimeArrayTimeZoneRule instances representing transitions.getTimeZoneRules in class BasicTimeZoneTimeZoneRule which represents this
time zone.public TimeZoneTransition getNextTransition(long base, boolean inclusive)
Example code:
System.out.println("### Iterates time zone transitions in America/Los_Angeles starting 2005-01-01 and forward"); // A TimeZone instance created by getTimeZone with TIMEZONE_ICU is always a BasicTimeZone BasicTimeZone btz = (BasicTimeZone)TimeZone.getTimeZone("America/Los_Angeles", TimeZone.TIMEZONE_ICU); // Date format for the wall time SimpleDateFormat wallTimeFmt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss z", ULocale.US); wallTimeFmt.setTimeZone(btz); long start = 1104537600000L; // 2005-01-01 0:00 UTC for (int i = 0; i < 5; i++) { // Up to 5 transitions TimeZoneTransition trans = btz.getNextTransition(start, false /* not including start time */); // Display the transition time and offset information long transTime = trans.getTime(); System.out.println(wallTimeFmt.format(new Date(transTime - 1)) + " -> " + wallTimeFmt.format(new Date(transTime))); System.out.println(" - Before (Offset/Save): " + trans.getFrom().getRawOffset() + "/" + trans.getFrom().getDSTSavings()); System.out.println(" - After (Offset/Save): " + trans.getTo().getRawOffset() + "/" + trans.getTo().getDSTSavings()); // Update start time for next transition start = transTime; }
getNextTransition in class BasicTimeZonebase - The base time.inclusive - Whether the base time is inclusive or not.Date holding the first time zone transition time
after the given base time, or null if no time zone transitions
are available after the base time.public TimeZoneTransition getPreviousTransition(long base, boolean inclusive)
Example code:
System.out.println("### Iterates time zone transitions in America/Los_Angeles starting 2010-01-01 and backward"); // A TimeZone instance created by getTimeZone with TIMEZONE_ICU is always a BasicTimeZone BasicTimeZone btz = (BasicTimeZone)TimeZone.getTimeZone("America/Los_Angeles", TimeZone.TIMEZONE_ICU); // Date format for the wall time SimpleDateFormat wallTimeFmt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss z", ULocale.US); wallTimeFmt.setTimeZone(btz); long start = 1262304000000L; // 2010-01-01 0:00 UTC for (int i = 0; i < 5; i++) { // Up to 5 transitions TimeZoneTransition trans = btz.getPreviousTransition(start, false /* not including start time */); // Display the transition time and offset information long transTime = trans.getTime(); System.out.println(wallTimeFmt.format(new Date(transTime - 1)) + " -> " + wallTimeFmt.format(new Date(transTime))); System.out.println(" - Before (Offset/Save): " + trans.getFrom().getRawOffset() + "/" + trans.getFrom().getDSTSavings()); System.out.println(" - After (Offset/Save): " + trans.getTo().getRawOffset() + "/" + trans.getTo().getDSTSavings()); // Update start time for next transition start = transTime; }
getPreviousTransition in class BasicTimeZonebase - The base time.inclusive - Whether the base time is inclusive or not.Date holding the last time zone transition time
before the given base time, or null if no time zone transitions
are available before the base time.public java.lang.Object clone()
public boolean isFrozen()
public TimeZone freeze()
public TimeZone cloneAsThawed()
cloneAsThawed in interface Freezable<TimeZone>cloneAsThawed in class TimeZoneCopyright © 2016 Unicode, Inc. and others.