X-Git-Url: https://git.saurik.com/apple/icu.git/blobdiff_plain/51004dcb01e06fef634b61be77ed73dd61cb6db9..38fbf2fd31f5cd99b500914d6037b1d06b608645:/icuSources/i18n/unicode/region.h diff --git a/icuSources/i18n/unicode/region.h b/icuSources/i18n/unicode/region.h index 12490bba..550b78b0 100644 --- a/icuSources/i18n/unicode/region.h +++ b/icuSources/i18n/unicode/region.h @@ -1,6 +1,8 @@ +// © 2016 and later: Unicode, Inc. and others. +// License & terms of use: http://www.unicode.org/copyright.html /* ******************************************************************************* - * Copyright (C) 2013, International Business Machines Corporation and others. + * Copyright (C) 2014-2016, International Business Machines Corporation and others. * All Rights Reserved. ******************************************************************************* */ @@ -17,13 +19,13 @@ #include "unicode/uregion.h" #if !UCONFIG_NO_FORMATTING -#ifndef U_HIDE_DRAFT_API #include "unicode/uobject.h" #include "unicode/uniset.h" #include "unicode/unistr.h" #include "unicode/strenum.h" +#if U_SHOW_CPLUSPLUS_API U_NAMESPACE_BEGIN /** @@ -63,26 +65,26 @@ U_NAMESPACE_BEGIN * The Region class is not intended for public subclassing. * * @author John Emmons - * @draft ICU 51 + * @stable ICU 51 */ class U_I18N_API Region : public UObject { public: /** * Destructor. - * @draft ICU 51 + * @stable ICU 51 */ virtual ~Region(); /** * Returns true if the two regions are equal. - * @draft ICU 51 + * @stable ICU 51 */ UBool operator==(const Region &that) const; /** * Returns true if the two regions are NOT equal; that is, if operator ==() returns false. - * @draft ICU 51 + * @stable ICU 51 */ UBool operator!=(const Region &that) const; @@ -91,28 +93,28 @@ public: * 3-letter ISO code, UNM.49 numeric code, or other valid Unicode Region Code as defined by the LDML specification. * The identifier will be canonicalized internally using the supplemental metadata as defined in the CLDR. * If the region code is NULL or not recognized, the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR ) - * @draft ICU 51 + * @stable ICU 51 */ static const Region* U_EXPORT2 getInstance(const char *region_code, UErrorCode &status); /** * Returns a pointer to a Region using the given numeric region code. If the numeric region code is not recognized, * the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR ). - * @draft ICU 51 + * @stable ICU 51 */ static const Region* U_EXPORT2 getInstance (int32_t code, UErrorCode &status); /** * Returns an enumeration over the IDs of all known regions that match the given type. - * @draft ICU 51 + * @stable ICU 55 */ - static StringEnumeration* U_EXPORT2 getAvailable(URegionType type); + static StringEnumeration* U_EXPORT2 getAvailable(URegionType type, UErrorCode &status); /** * Returns a pointer to the region that contains this region. Returns NULL if this region is code "001" (World) * or "ZZ" (Unknown region). For example, calling this method with region "IT" (Italy) returns the * region "039" (Southern Europe). - * @draft ICU 51 + * @stable ICU 51 */ const Region* getContainingRegion() const; @@ -122,7 +124,7 @@ public: * that matches the given type. Note: The URegionTypes = "URGN_GROUPING", "URGN_DEPRECATED", or "URGN_UNKNOWN" * are not appropriate for use in this API. NULL will be returned in this case. For example, calling this method * with region "IT" (Italy) for type "URGN_CONTINENT" returns the region "150" ( Europe ). - * @draft ICU 51 + * @stable ICU 51 */ const Region* getContainingRegion(URegionType type) const; @@ -133,22 +135,22 @@ public: * any sub-regions. For example, calling this method with region "150" (Europe) returns an enumeration containing * the various sub regions of Europe - "039" (Southern Europe) - "151" (Eastern Europe) - "154" (Northern Europe) * and "155" (Western Europe). - * @draft ICU 51 + * @stable ICU 55 */ - StringEnumeration* getContainedRegions() const; + StringEnumeration* getContainedRegions(UErrorCode &status) const; /** * Returns an enumeration over the IDs of all the regions that are children of this region anywhere in the region * hierarchy and match the given type. This API may return an empty enumeration if this region doesn't have any * sub-regions that match the given type. For example, calling this method with region "150" (Europe) and type * "URGN_TERRITORY" returns a set containing all the territories in Europe ( "FR" (France) - "IT" (Italy) - "DE" (Germany) etc. ) - * @draft ICU 51 + * @stable ICU 55 */ - StringEnumeration* getContainedRegions( URegionType type ) const; + StringEnumeration* getContainedRegions( URegionType type, UErrorCode &status ) const; /** * Returns true if this region contains the supplied other region anywhere in the region hierarchy. - * @draft ICU 51 + * @stable ICU 51 */ UBool contains(const Region &other) const; @@ -156,27 +158,26 @@ public: * For deprecated regions, return an enumeration over the IDs of the regions that are the preferred replacement * regions for this region. Returns null for a non-deprecated region. For example, calling this method with region * "SU" (Soviet Union) would return a list of the regions containing "RU" (Russia), "AM" (Armenia), "AZ" (Azerbaijan), etc... - * @draft ICU 51 + * @stable ICU 55 */ - StringEnumeration* getPreferredValues() const; - + StringEnumeration* getPreferredValues(UErrorCode &status) const; /** * Return this region's canonical region code. - * @draft ICU 51 + * @stable ICU 51 */ const char* getRegionCode() const; /** * Return this region's numeric code. * Returns a negative value if the given region does not have a numeric code assigned to it. - * @draft ICU 51 + * @stable ICU 51 */ int32_t getNumericCode() const; /** * Returns the region type of this region. - * @draft ICU 51 + * @stable ICU 51 */ URegionType getType() const; @@ -199,8 +200,6 @@ private: /** * Default Constructor. Internal - use factory methods only. - * - * @internal */ Region(); @@ -212,16 +211,15 @@ private: * * If the region data has already loaded, then this method simply returns without doing * anything meaningful. - * @internal */ - static void loadRegionData(); + static void U_CALLCONV loadRegionData(UErrorCode &status); }; U_NAMESPACE_END +#endif // U_SHOW_CPLUSPLUS_API -#endif /* U_HIDE_DRAFT_API */ #endif /* #if !UCONFIG_NO_FORMATTING */ #endif // REGION_H