/*
*******************************************************************************
-* Copyright (C) 2007-2008, International Business Machines Corporation and *
+* Copyright (C) 2007-2010, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
* With the <code>VTimeZone</code> instance created from the ID, you can write out the rule
* in RFC2445 VTIMEZONE format. Also, you can create a <code>VTimeZone</code> instance
* from RFC2445 VTIMEZONE data stream, which allows you to calculate time
- * zone offset by the rules defined by the data.<br><br>
+ * zone offset by the rules defined by the data. Or, you can create a
+ * <code>VTimeZone</code> from any other ICU <code>BasicTimeZone</code>.
+ * <br><br>
* Note: The consumer of this class reading or writing VTIMEZONE data is responsible to
* decode or encode Non-ASCII text. Methods reading/writing VTIMEZONE data in this class
* do nothing with MIME encoding.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
class U_I18N_API VTimeZone : public BasicTimeZone {
public:
/**
* Copy constructor.
* @param source The <code>VTimeZone</code> object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
VTimeZone(const VTimeZone& source);
/**
* Destructor.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual ~VTimeZone();
/**
* Assignment operator.
* @param right The object to be copied.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
VTimeZone& operator=(const VTimeZone& right);
* @param that The object to be compared with.
* @return true if the given <code>TimeZone</code> objects are
*semantically equal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator==(const TimeZone& that) const;
* @param that The object to be compared with.
* @return true if the given <code>TimeZone</code> objects are
* semantically unequal.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool operator!=(const TimeZone& that) const;
* @param ID The time zone ID, such as America/New_York
* @return A <code>VTimeZone</code> object initialized by the time zone ID,
* or NULL when the ID is unknown.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
static VTimeZone* createVTimeZoneByID(const UnicodeString& ID);
+ /**
+ * Create a <code>VTimeZone</code> instance using a basic time zone.
+ * @param basicTZ The basic time zone instance
+ * @param status Output param to filled in with a success or an error.
+ * @return A <code>VTimeZone</code> object initialized by the basic time zone.
+ * @draft ICU 4.6
+ */
+ static VTimeZone* createVTimeZoneFromBasicTimeZone(const BasicTimeZone& basicTZ,
+ UErrorCode &status);
+
/**
* Create a <code>VTimeZone</code> instance by RFC2445 VTIMEZONE data
*
* @param status Output param to filled in with a success or an error.
* @return A <code>VTimeZone</code> initialized by the VTIMEZONE data or
* NULL if failed to load the rule from the VTIMEZONE data.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
static VTimeZone* createVTimeZone(const UnicodeString& vtzdata, UErrorCode& status);
* in the data. Otherwise, the initial value is not set.
* @param url Receives the RFC2445 TZURL property value.
* @return TRUE if TZURL attribute is available and value is set.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
UBool getTZURL(UnicodeString& url) const;
/**
* Sets the RFC2445 TZURL property value.
* @param url The TZURL property value.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
void setTZURL(const UnicodeString& url);
* value in the data. Otherwise, the initial value is not set.
* @param lastModified Receives the last modified date.
* @return TRUE if lastModified attribute is available and value is set.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
UBool getLastModified(UDate& lastModified) const;
/**
* Sets the RFC2445 LAST-MODIFIED property value.
* @param lastModified The LAST-MODIFIED date.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
void setLastModified(UDate lastModified);
* Writes RFC2445 VTIMEZONE data for this time zone
* @param result Output param to filled in with the VTIMEZONE data.
* @param status Output param to filled in with a success or an error.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
void write(UnicodeString& result, UErrorCode& status) const;
* @param start The start date.
* @param result Output param to filled in with the VTIMEZONE data.
* @param status Output param to filled in with a success or an error.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
void write(UDate start, UnicodeString& result, UErrorCode& status) /*const*/;
* @param time The date used for rule extraction.
* @param result Output param to filled in with the VTIMEZONE data.
* @param status Output param to filled in with a success or an error.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
void writeSimple(UDate time, UnicodeString& result, UErrorCode& status) /*const*/;
* Clones TimeZone objects polymorphically. Clients are responsible for deleting
* the TimeZone object cloned.
* @return A new copy of this TimeZone object.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual TimeZone* clone(void) const;
* @param millis The reference date's milliseconds in day, local standard time
* @param status Output param to filled in with a success or an error.
* @return The offset in milliseconds to add to GMT to get local time.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const;
* @param monthLength The length of the given month in days.
* @param status Output param to filled in with a success or an error.
* @return The offset in milliseconds to add to GMT to get local time.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
uint8_t dayOfWeek, int32_t millis,
* effect, this value is zero; otherwise it is a positive value,
* typically one hour.
* @param ec input-output error code
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
int32_t& dstOffset, UErrorCode& ec) const;
* to GMT to get local time, before taking daylight savings time into account).
*
* @param offsetMillis The new raw GMT offset for this time zone.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual void setRawOffset(int32_t offsetMillis);
* to GMT to get local time, before taking daylight savings time into account).
*
* @return The TimeZone's raw GMT offset.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual int32_t getRawOffset(void) const;
* Queries if this time zone uses daylight savings time.
* @return true if this time zone uses daylight savings time,
* false, otherwise.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool useDaylightTime(void) const;
* @param other the <code>TimeZone</code> object to be compared with
* @return true if the given zone is the same as this one,
* with the possible exception of the ID
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool hasSameRules(const TimeZone& other) const;
* @param inclusive Whether the base time is inclusive or not.
* @param result Receives the first transition after the base time.
* @return TRUE if the transition is found.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getNextTransition(UDate base, UBool inclusive, TimeZoneTransition& result) /*const*/;
* @param inclusive Whether the base time is inclusive or not.
* @param result Receives the most recent transition before the base time.
* @return TRUE if the transition is found.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual UBool getPreviousTransition(UDate base, UBool inclusive, TimeZoneTransition& result) /*const*/;
* <code>InitialTimeZoneRule</code>. The return value range is 0 or any positive value.
* @param status Receives error status code.
* @return The number of <code>TimeZoneRule</code>s representing time transitions.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual int32_t countTransitionRules(UErrorCode& status) /*const*/;
* the timezone transition rules. On output, actual number of
* rules filled in the array will be set.
* @param status Receives error status code.
- * @stable ICU 4.0
+ * @stable ICU 3.8
*/
virtual void getTimeZoneRules(const InitialTimeZoneRule*& initial,
const TimeZoneRule* trsrules[], int32_t& trscount, UErrorCode& status) /*const*/;
void writeHeaders(VTZWriter& w, UErrorCode& status) const;
void writeFooter(VTZWriter& writer, UErrorCode& status) const;
- void writeZonePropsByTime(VTZWriter& writer, UBool isDst, const UnicodeString& tzname,
+ void writeZonePropsByTime(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
int32_t fromOffset, int32_t toOffset, UDate time, UBool withRDATE,
UErrorCode& status) const;
- void writeZonePropsByDOM(VTZWriter& writer, UBool isDst, const UnicodeString& tzname,
+ void writeZonePropsByDOM(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
int32_t fromOffset, int32_t toOffset,
int32_t month, int32_t dayOfMonth, UDate startTime, UDate untilTime,
UErrorCode& status) const;
- void writeZonePropsByDOW(VTZWriter& writer, UBool isDst, const UnicodeString& tzname,
+ void writeZonePropsByDOW(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
int32_t fromOffset, int32_t toOffset,
int32_t month, int32_t weekInMonth, int32_t dayOfWeek,
UDate startTime, UDate untilTime, UErrorCode& status) const;
- void writeZonePropsByDOW_GEQ_DOM(VTZWriter& writer, UBool isDst, const UnicodeString& tzname,
+ void writeZonePropsByDOW_GEQ_DOM(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
int32_t fromOffset, int32_t toOffset,
int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
UDate startTime, UDate untilTime, UErrorCode& status) const;
void writeZonePropsByDOW_GEQ_DOM_sub(VTZWriter& writer, int32_t month, int32_t dayOfMonth,
int32_t dayOfWeek, int32_t numDays,
UDate untilTime, int32_t fromOffset, UErrorCode& status) const;
- void writeZonePropsByDOW_LEQ_DOM(VTZWriter& writer, UBool isDst, const UnicodeString& tzname,
+ void writeZonePropsByDOW_LEQ_DOM(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
int32_t fromOffset, int32_t toOffset,
int32_t month, int32_t dayOfMonth, int32_t dayOfWeek,
UDate startTime, UDate untilTime, UErrorCode& status) const;
int32_t fromRawOffset, int32_t fromDSTSavings,
UDate startTime, UErrorCode& status) const;
- void beginZoneProps(VTZWriter& writer, UBool isDst, const UnicodeString& tzname,
+ void beginZoneProps(VTZWriter& writer, UBool isDst, const UnicodeString& zonename,
int32_t fromOffset, int32_t toOffset, UDate startTime, UErrorCode& status) const;
void endZoneProps(VTZWriter& writer, UBool isDst, UErrorCode& status) const;
void beginRRULE(VTZWriter& writer, int32_t month, UErrorCode& status) 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