* <code>TimeZoneRule</code> has a set of time zone attributes, such as zone name,
* raw offset (UTC offset for standard time) and daylight saving time offset.
*
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
class U_I18N_API TimeZoneRule : public UObject {
public:
/**
* Destructor.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual ~TimeZoneRule();
* Clone this TimeZoneRule object polymorphically. The caller owns the result and
* should delete it when done.
* @return A copy of the object.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual TimeZoneRule* clone(void) const = 0;
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically equal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator==(const TimeZoneRule& that) const;
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically unequal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator!=(const TimeZoneRule& that) const;
* Fills in "name" with the name of this time zone.
* @param name Receives the name of this time zone.
* @return A reference to "name"
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
UnicodeString& getName(UnicodeString& name) const;
/**
* Gets the standard time offset.
* @return The standard time offset from UTC in milliseconds.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
int32_t getRawOffset(void) const;
* Gets the amount of daylight saving delta time from the standard time.
* @return The amount of daylight saving offset used by this rule
* in milliseconds.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
int32_t getDSTSavings(void) const;
* returns true.
* @param other The <code>TimeZoneRule</code> object to be compared with.
* @return true if the other <code>TimeZoneRule</code> is the same as this one.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool isEquivalentTo(const TimeZoneRule& other) const;
* @param result Receives the very first time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFirstStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const = 0;
* @param result Receives the final time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFinalStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const = 0;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getNextStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const = 0;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getPreviousStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const = 0;
* @param rawOffset The UTC offset of its standard time in milliseconds.
* @param 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.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
TimeZoneRule(const UnicodeString& name, int32_t rawOffset, int32_t dstSavings);
/**
* Copy constructor.
* @param source The TimeZoneRule object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
TimeZoneRule(const TimeZoneRule& source);
/**
* Assignment operator.
* @param right The object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
TimeZoneRule& operator=(const TimeZoneRule& right);
* <code>InitialTimeZoneRule</code> represents a time zone rule
* representing a time zone effective from the beginning and
* has no actual start times.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
class U_I18N_API InitialTimeZoneRule : public TimeZoneRule {
public:
* @param rawOffset The UTC offset of its standard time in milliseconds.
* @param 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.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
InitialTimeZoneRule(const UnicodeString& name, int32_t rawOffset, int32_t dstSavings);
/**
* Copy constructor.
* @param source The InitialTimeZoneRule object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
InitialTimeZoneRule(const InitialTimeZoneRule& source);
/**
* Destructor.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual ~InitialTimeZoneRule();
* Clone this InitialTimeZoneRule object polymorphically. The caller owns the result and
* should delete it when done.
* @return A copy of the object.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual InitialTimeZoneRule* clone(void) const;
/**
* Assignment operator.
* @param right The object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
InitialTimeZoneRule& operator=(const InitialTimeZoneRule& right);
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically equal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator==(const TimeZoneRule& that) const;
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically unequal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator!=(const TimeZoneRule& that) const;
* @param result Receives the start time in the year.
* @return true if this rule takes effect in the year and the result is set to
* "result".
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
UBool getStartInYear(int32_t year, int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* returns true.
* @param that The <code>TimeZoneRule</code> object to be compared with.
* @return true if the other <code>TimeZoneRule</code> is equivalent to this one.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool isEquivalentTo(const TimeZoneRule& that) const;
* @param result Receives the very first time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFirstStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* @param result Receives the final time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFinalStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getNextStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getPreviousStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const;
* . erived::getStaticClassID()) ...
* </pre>
* @return The class ID for all objects of this class.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
static UClassID U_EXPORT2 getStaticClassID(void);
* @return The class ID for this object. All objects of a
* given class have the same class ID. Objects of
* other classes have different class IDs.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UClassID getDynamicClassID(void) const;
};
* rule which takes effect annually. The calenday system used for the rule is
* is based on Gregorian calendar
*
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
class U_I18N_API AnnualTimeZoneRule : public TimeZoneRule {
public:
* @param startYear The first year when this rule takes effect.
* @param endYear The last year when this rule takes effect. If this
* rule is effective forever in future, specify MAX_YEAR.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
AnnualTimeZoneRule(const UnicodeString& name, int32_t rawOffset, int32_t dstSavings,
const DateTimeRule& dateTimeRule, int32_t startYear, int32_t endYear);
* @param startYear The first year when this rule takes effect.
* @param endYear The last year when this rule takes effect. If this
* rule is effective forever in future, specify MAX_YEAR.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
AnnualTimeZoneRule(const UnicodeString& name, int32_t rawOffset, int32_t dstSavings,
DateTimeRule* dateTimeRule, int32_t startYear, int32_t endYear);
/**
* Copy constructor.
* @param source The AnnualTimeZoneRule object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
AnnualTimeZoneRule(const AnnualTimeZoneRule& source);
/**
* Destructor.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual ~AnnualTimeZoneRule();
* Clone this AnnualTimeZoneRule object polymorphically. The caller owns the result and
* should delete it when done.
* @return A copy of the object.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual AnnualTimeZoneRule* clone(void) const;
/**
* Assignment operator.
* @param right The object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
AnnualTimeZoneRule& operator=(const AnnualTimeZoneRule& right);
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically equal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator==(const TimeZoneRule& that) const;
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically unequal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator!=(const TimeZoneRule& that) const;
* Gets the start date/time rule used by this rule.
* @return The <code>AnnualDateTimeRule</code> which represents the start date/time
* rule used by this time zone rule.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
const DateTimeRule* getRule(void) const;
* Gets the first year when this rule takes effect.
* @return The start year of this rule. The year is in Gregorian calendar
* with 0 == 1 BCE, -1 == 2 BCE, etc.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
int32_t getStartYear(void) const;
* Gets the end year when this rule takes effect.
* @return The end year of this rule (inclusive). The year is in Gregorian calendar
* with 0 == 1 BCE, -1 == 2 BCE, etc.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
int32_t getEndYear(void) const;
* @param result Receives the start time in the year.
* @return true if this rule takes effect in the year and the result is set to
* "result".
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
UBool getStartInYear(int32_t year, int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* returns true.
* @param that The <code>TimeZoneRule</code> object to be compared with.
* @return true if the other <code>TimeZoneRule</code> is equivalent to this one.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool isEquivalentTo(const TimeZoneRule& that) const;
* @param result Receives the very first time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFirstStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* @param result Receives the final time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFinalStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getNextStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getPreviousStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const;
* . erived::getStaticClassID()) ...
* </pre>
* @return The class ID for all objects of this class.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
static UClassID U_EXPORT2 getStaticClassID(void);
* @return The class ID for this object. All objects of a
* given class have the same class ID. Objects of
* other classes have different class IDs.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UClassID getDynamicClassID(void) const;
};
* <code>TimeArrayTimeZoneRule</code> represents a time zone rule whose start times are
* defined by an array of milliseconds since the standard base time.
*
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
class U_I18N_API TimeArrayTimeZoneRule : public TimeZoneRule {
public:
* @param timeRuleType The time type of the start times, which is one of
* <code>DataTimeRule::WALL_TIME</code>, <code>STANDARD_TIME</code>
* and <code>UTC_TIME</code>.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
TimeArrayTimeZoneRule(const UnicodeString& name, int32_t rawOffset, int32_t dstSavings,
const UDate* startTimes, int32_t numStartTimes, DateTimeRule::TimeRuleType timeRuleType);
/**
* Copy constructor.
* @param source The TimeArrayTimeZoneRule object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
TimeArrayTimeZoneRule(const TimeArrayTimeZoneRule& source);
/**
* Destructor.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual ~TimeArrayTimeZoneRule();
* Clone this TimeArrayTimeZoneRule object polymorphically. The caller owns the result and
* should delete it when done.
* @return A copy of the object.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual TimeArrayTimeZoneRule* clone(void) const;
/**
* Assignment operator.
* @param right The object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
TimeArrayTimeZoneRule& operator=(const TimeArrayTimeZoneRule& right);
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically equal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator==(const TimeZoneRule& that) const;
* of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given <code>TimeZoneRule</code> objects are semantically unequal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator!=(const TimeZoneRule& that) const;
* or <code>UTC_TIME</code>.
*
* @return The time type used of the start times used by this rule.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
DateTimeRule::TimeRuleType getTimeType(void) const;
* @return true if the index is within the valid range and
* and the result is set. When false, the output
* parameger "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
UBool getStartTimeAt(int32_t index, UDate& result) const;
/**
* Returns the number of start times stored in this rule
* @return The number of start times.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
int32_t countStartTimes(void) const;
* returns true.
* @param that The <code>TimeZoneRule</code> object to be compared with.
* @return true if the other <code>TimeZoneRule</code> is equivalent to this one.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool isEquivalentTo(const TimeZoneRule& that) const;
* @param result Receives the very first time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFirstStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* @param result Receives the final time when this rule takes effect.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getFinalStart(int32_t prevRawOffset, int32_t prevDSTSavings, UDate& result) const;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getNextStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const;
* the specified base time.
* @return true if the start time is available. When false is returned, output parameter
* "result" is unchanged.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getPreviousStart(UDate base, int32_t prevRawOffset, int32_t prevDSTSavings,
UBool inclusive, UDate& result) const;
* . erived::getStaticClassID()) ...
* </pre>
* @return The class ID for all objects of this class.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
static UClassID U_EXPORT2 getStaticClassID(void);
* @return The class ID for this object. All objects of a
* given class have the same class ID. Objects of
* other classes have different class IDs.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UClassID getDynamicClassID(void) const;
};
projects / apple / icu.git / blobdiff