com.ibm.icu.util

Class AnnualTimeZoneRule

java.lang.Object

com.ibm.icu.util.TimeZoneRule

com.ibm.icu.util.AnnualTimeZoneRule

All Implemented Interfaces:

Serializable

public class AnnualTimeZoneRule
extends TimeZoneRule

AnnualTimeZoneRule is a class used for representing a time zone rule which takes effect annually. Years used in this class are all Gregorian calendar years.

See Also:

Serialized Form

Status:

Stable ICU 3.8.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_YEAR The constant representing the maximum year used for designating a rule is permanent.

Constructor Summary

Constructors

Constructor and Description
AnnualTimeZoneRule(String name, int rawOffset, int dstSavings, DateTimeRule dateTimeRule, int startYear, int endYear) Constructs a AnnualTimeZoneRule with the name, the GMT offset of its standard time, the amount of daylight saving offset adjustment, the annual start time rule and the start/until years.

Method Summary

Modifier and Type	Method and Description
int	getEndYear() Gets the end year when this rule takes effect.
Date	getFinalStart(int prevRawOffset, int prevDSTSavings) Gets the final time when this rule takes effect.
Date	getFirstStart(int prevRawOffset, int prevDSTSavings) Gets the very first time when this rule takes effect.
Date	getNextStart(long base, int prevRawOffset, int prevDSTSavings, boolean inclusive) Gets the first time when this rule takes effect after the specified time.
Date	getPreviousStart(long base, int prevRawOffset, int prevDSTSavings, boolean inclusive) Gets the most recent time when this rule takes effect before the specified time.
DateTimeRule	getRule() Gets the start date/time rule associated used by this rule.
Date	getStartInYear(int year, int prevRawOffset, int prevDSTSavings) Gets the time when this rule takes effect in the given year.
int	getStartYear() Gets the first year when this rule takes effect.
boolean	isEquivalentTo(TimeZoneRule other) Returns if this rule represents the same rule and offsets as another.
boolean	isTransitionRule() Returns if this TimeZoneRule has one or more start times.
String	toString() Returns a String representation of this AnnualTimeZoneRule object.

Methods inherited from class com.ibm.icu.util.TimeZoneRule

getDSTSavings, getName, getRawOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_YEAR

public static final int MAX_YEAR

The constant representing the maximum year used for designating a rule is permanent.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

Constructor Detail

AnnualTimeZoneRule

public AnnualTimeZoneRule(String name,
                          int rawOffset,
                          int dstSavings,
                          DateTimeRule dateTimeRule,
                          int startYear,
                          int endYear)

Constructs a AnnualTimeZoneRule with the name, the GMT offset of its standard time, the amount of daylight saving offset adjustment, the annual start time rule and the start/until years.

Parameters:

name - The time zone name.

rawOffset - The GMT offset of its standard time in milliseconds.

dstSavings - The amount of daylight saving offset adjustment in milliseconds. If this ia a rule for standard time, the value of this argument is 0.

dateTimeRule - The start date/time rule repeated annually.

startYear - The first year when this rule takes effect.

endYear - The last year when this rule takes effect. If this rule is effective forever in future, specify MAX_YEAR.

Status:

Stable ICU 3.8.

Method Detail

getRule

public DateTimeRule getRule()

Gets the start date/time rule associated used by this rule.

Returns:

An AnnualDateTimeRule which represents the start date/time rule used by this time zone rule.

Status:

Stable ICU 3.8.

getStartYear

public int getStartYear()

Gets the first year when this rule takes effect.

Returns:

The start year of this rule. The year is in Gregorian calendar with 0 == 1 BCE, -1 == 2 BCE, etc.

Status:

Stable ICU 3.8.

getEndYear

public int getEndYear()

Gets the end year when this rule takes effect.

Returns:

The end year of this rule (inclusive). The year is in Gregorian calendar with 0 == 1 BCE, -1 == 2 BCE, etc.

Status:

Stable ICU 3.8.

getStartInYear

public Date getStartInYear(int year,
                           int prevRawOffset,
                           int prevDSTSavings)

Gets the time when this rule takes effect in the given year.

Parameters:

year - The Gregorian year, with 0 == 1 BCE, -1 == 2 BCE, etc.

prevRawOffset - The standard time offset from UTC before this rule takes effect in milliseconds.

prevDSTSavings - The amount of daylight saving offset from the standard time.

Returns:

The time when this rule takes effect in the year, or null if this rule is not applicable in the year.

Status:

Stable ICU 3.8.

getFirstStart

public Date getFirstStart(int prevRawOffset,
                          int prevDSTSavings)

Gets the very first time when this rule takes effect.

Specified by:

getFirstStart in class TimeZoneRule

Parameters:

prevRawOffset - The standard time offset from UTC before this rule takes effect in milliseconds.

prevDSTSavings - The amount of daylight saving offset from the standard time.

Returns:

The very first time when this rule takes effect.

Status:

Stable ICU 3.8.

getFinalStart

public Date getFinalStart(int prevRawOffset,
                          int prevDSTSavings)

Gets the final time when this rule takes effect.

Specified by:

getFinalStart in class TimeZoneRule

Parameters:

prevRawOffset - The standard time offset from UTC before this rule takes effect in milliseconds.

prevDSTSavings - The amount of daylight saving offset from the standard time.

Returns:

The very last time when this rule takes effect, or null if this rule is applied for future dates infinitely.

Status:

Stable ICU 3.8.

getNextStart

public Date getNextStart(long base,
                         int prevRawOffset,
                         int prevDSTSavings,
                         boolean inclusive)

Gets the first time when this rule takes effect after the specified time.

Specified by:

getNextStart in class TimeZoneRule

Parameters:

base - The first time after this time is returned.

prevRawOffset - The standard time offset from UTC before this rule takes effect in milliseconds.

prevDSTSavings - The amount of daylight saving offset from the standard time.

inclusive - Whether the base time is inclusive or not.

Returns:

The first time when this rule takes effect after the specified time, or null when this rule never takes effect after the specified time.

Status:

Stable ICU 3.8.

getPreviousStart

public Date getPreviousStart(long base,
                             int prevRawOffset,
                             int prevDSTSavings,
                             boolean inclusive)

Gets the most recent time when this rule takes effect before the specified time.

Specified by:

getPreviousStart in class TimeZoneRule

Parameters:

base - The most recent time when this rule takes effect before this time is returned.

prevRawOffset - The standard time offset from UTC before this rule takes effect in milliseconds.

prevDSTSavings - The amount of daylight saving offset from the standard time.

inclusive - Whether the base time is inclusive or not.

Returns:

The most recent time when this rule takes effect before the specified time, or null when this rule never takes effect before the specified time.

Status:

Stable ICU 3.8.

isEquivalentTo

public boolean isEquivalentTo(TimeZoneRule other)

Returns if this rule represents the same rule and offsets as another. When two TimeZoneRule objects differ only its names, this method returns true.

Overrides:

isEquivalentTo in class TimeZoneRule

Parameters:

other - The TimeZoneRule object to be compared with.

Returns:

true if the other TimeZoneRule is the same as this one.

Status:

Stable ICU 3.8.

isTransitionRule

public boolean isTransitionRule()

Returns if this TimeZoneRule has one or more start times.

Note: This method in AnnualTimeZoneRule always returns true.

Specified by:

isTransitionRule in class TimeZoneRule

Returns:

true if this TimeZoneRule has one or more start times.

Status:

Stable ICU 3.8.

toString

public String toString()

Returns a String representation of this AnnualTimeZoneRule object. This method is used for debugging purpose only. The string representation can be changed in future version of ICU without any notice.

Overrides:

toString in class TimeZoneRule

Status:

Stable ICU 3.8.