com.ibm.icu.text
Class UFormat

java.lang.Object
  extended byjava.text.Format
      extended bycom.ibm.icu.text.UFormat
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
DateFormat, MeasureFormat, MessageFormat, NumberFormat

public abstract class UFormat
extends java.text.Format

An abstract class that extends Format to provide additional ICU protocol, specifically, the getLocale() API. All ICU format classes are subclasses of this class.

Author:
weiv, Alan Liu
See Also:
ULocale, Serialized Form
Status:
Draft ICU 2.8 (retain).

Nested Class Summary
 
Nested classes inherited from class java.text.Format
java.text.Format.Field
 
Constructor Summary
UFormat()
           
 
Method Summary
 ULocale getLocale(ULocale.Type type)
          Return the locale that was used to create this object, or null.
 
Methods inherited from class java.text.Format
clone, format, format, formatToCharacterIterator, parseObject, parseObject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UFormat

public UFormat()
Status:
Draft ICU 2.8 (retain).
Method Detail

getLocale

public final ULocale getLocale(ULocale.Type type)
Return the locale that was used to create this object, or null. This may may differ from the locale requested at the time of this object's creation. For example, if an object is created for locale en_US_CALIFORNIA, the actual data may be drawn from en (the actual locale), and en_US may be the most specific locale that exists (the valid locale).

Note: This method will be implemented in ICU 3.0; ICU 2.8 contains a partial preview implementation. The actual locale is returned correctly, but the valid locale is not, in most cases.

Parameters:
type - type of information requested, either ULocale.VALID_LOCALE or ULocale.ACTUAL_LOCALE.
Returns:
the information specified by type, or null if this object was not constructed from locale data.
See Also:
ULocale, ULocale.VALID_LOCALE, ULocale.ACTUAL_LOCALE
Status:
Draft ICU 2.8 (retain).


Copyright (c) 2006 IBM Corporation and others.