ICU-9475 Some additional notes in TimeZoneNames API reference.

X-SVN-Rev: 33228
This commit is contained in:
Yoshito Umaoka 2013-02-14 22:50:17 +00:00
parent 049fb62622
commit d4ca6e2dec

View File

@ -63,6 +63,13 @@ import com.ibm.icu.util.ULocale;
* may provide time zone names only through {@link #getTimeZoneDisplayName(String, NameType)}, or only through
* {@link #getMetaZoneDisplayName(String, NameType)}, or both.
*
* <p>
* The default <code>TimeZoneNames</code> implementation returned by {@link #getInstance(ULocale)} uses the locale data
* imported from CLDR. In CLDR, set of meta zone IDs and mappings between zone IDs and meta zone IDs are shared by all
* locales. Therefore, the behavior of {@link #getAvailableMetaZoneIDs()}, {@link #getAvailableMetaZoneIDs(String)},
* {@link #getMetaZoneID(String, long)}, and {@link #getReferenceZoneID(String, String)} won't be changed no matter
* what locale is used for getting an instance of <code>TimeZoneNames</code>.
*
* @draft ICU 49
* @provisional This API might change or be removed in a future release.
*/
@ -211,6 +218,11 @@ public abstract class TimeZoneNames implements Serializable {
/**
* Returns the reference zone ID for the given meta zone ID for the region.
*
* Note: Each meta zone must have a reference zone associated with a special region "001" (world).
* Some meta zones may have region specific reference zone IDs other than the special region
* "001". When a meta zone does not have any region specific reference zone IDs, this method
* return the reference zone ID for the special region "001" (world).
*
* @param mzID
* The meta zone ID.
* @param region