1
+ lY> j-
y_I|+ ? // © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2007-2013, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
#ifndef VTZONE_H
#define VTZONE_H
#include "unicode/utypes.h"
#if U_SHOW_CPLUSPLUS_API
/**
* \file
* \brief C++ API: RFC2445 VTIMEZONE support
*/
#if !UCONFIG_NO_FORMATTING
#include "unicode/basictz.h"
U_NAMESPACE_BEGIN
class VTZWriter;
class VTZReader;
class UVector;
/**
* VTimeZone is a class implementing RFC2445 VTIMEZONE. You can create a
* VTimeZone instance from a time zone ID supported by TimeZone.
* With the VTimeZone instance created from the ID, you can write out the rule
* in RFC2445 VTIMEZONE format. Also, you can create a VTimeZone instance
* from RFC2445 VTIMEZONE data stream, which allows you to calculate time
* zone offset by the rules defined by the data. Or, you can create a
* VTimeZone from any other ICU BasicTimeZone.
*
* 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 3.8
*/
class U_I18N_API VTimeZone : public BasicTimeZone {
public:
/**
* Copy constructor.
* @param source The VTimeZone object to be copied.
* @stable ICU 3.8
*/
VTimeZone(const VTimeZone& source);
/**
* Destructor.
* @stable ICU 3.8
*/
virtual ~VTimeZone();
/**
* Assignment operator.
* @param right The object to be copied.
* @stable ICU 3.8
*/
VTimeZone& operator=(const VTimeZone& right);
/**
* Return true if the given TimeZone objects are
* semantically equal. Objects of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given TimeZone objects are
*semantically equal.
* @stable ICU 3.8
*/
virtual UBool operator==(const TimeZone& that) const;
/**
* Return true if the given TimeZone objects are
* semantically unequal. Objects of different subclasses are considered unequal.
* @param that The object to be compared with.
* @return true if the given TimeZone objects are
* semantically unequal.
* @stable ICU 3.8
*/
virtual UBool operator!=(const TimeZone& that) const;
/**
* Create a VTimeZone instance by the time zone ID.
* @param ID The time zone ID, such as America/New_York
* @return A VTimeZone object initialized by the time zone ID,
* or NULL when the ID is unknown.
* @stable ICU 3.8
*/
static VTimeZone* createVTimeZoneByID(const UnicodeString& ID);
/**
* Create a VTimeZone 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 VTimeZone object initialized by the basic time zone.
* @stable ICU 4.6
*/
static VTimeZone* createVTimeZoneFromBasicTimeZone(const BasicTimeZone& basicTZ,
UErrorCode &status);
/**
* Create a VTimeZone instance by RFC2445 VTIMEZONE data
*
* @param vtzdata The string including VTIMEZONE data block
* @param status Output param to filled in with a success or an error.
* @return A VTimeZone initialized by the VTIMEZONE data or
* NULL if failed to load the rule from the VTIMEZONE data.
* @stable ICU 3.8
*/
static VTimeZone* cr