1/*
2 *******************************************************************************
3 * Copyright (C) 2003-2012, International Business Machines Corporation and    *
4 * others. All Rights Reserved.                                                *
5 *******************************************************************************
6 */
7package com.ibm.icu.text;
8
9import java.text.Format;
10
11/**
12 * An abstract class that extends {@link java.text.Format} to provide
13 * additional ICU protocol, specifically, the <tt>getLocale()</tt>
14 * API.  All ICU format classes are subclasses of this class.
15 *
16 * @see com.ibm.icu.util.ULocale
17 * @author weiv
18 * @author Alan Liu
19 * @draft ICU 2.8 (retain)
20 * @provisional This API might change or be removed in a future release.
21 */
22public abstract class UFormat extends Format {
23    private static final long serialVersionUID = 1L;
24
25    /**
26     * @draft ICU 2.8 (retain)
27     * @provisional This API might change or be removed in a future release.
28     */
29    public UFormat() {}
30
31//    /**
32//     * Return the locale that was used to create this object, or null.
33//     * This may may differ from the locale requested at the time of
34//     * this object's creation.  For example, if an object is created
35//     * for locale <tt>en_US_CALIFORNIA</tt>, the actual data may be
36//     * drawn from <tt>en</tt> (the <i>actual</i> locale), and
37//     * <tt>en_US</tt> may be the most specific locale that exists (the
38//     * <i>valid</i> locale).
39//     *
40//     * <p>Note: This method will be implemented in ICU 3.0; ICU 2.8
41//     * contains a partial preview implementation.  The <i>actual</i>
42//     * locale is returned correctly, but the <i>valid</i> locale is
43//     * not, in most cases.
44//     * @param type type of information requested, either {@link
45//     * com.ibm.icu.util.ULocale#VALID_LOCALE} or {@link
46//     * com.ibm.icu.util.ULocale#ACTUAL_LOCALE}.
47//     * @return the information specified by <i>type</i>, or null if
48//     * this object was not constructed from locale data.
49//     * @see com.ibm.icu.util.ULocale
50//     * @see com.ibm.icu.util.ULocale#VALID_LOCALE
51//     * @see com.ibm.icu.util.ULocale#ACTUAL_LOCALE
52//     * @draft ICU 2.8 (retain)
53//     * @provisional This API might change or be removed in a future release.
54//     */
55//    public final ULocale getLocale(ULocale.Type type) {
56//        throw new UnsupportedOperationException("Method not supported by com.ibm.icu.base");
57//    }
58
59//    /**
60//     * Set information about the locales that were used to create this
61//     * object.  If the object was not constructed from locale data,
62//     * both arguments should be set to null.  Otherwise, neither
63//     * should be null.  The actual locale must be at the same level or
64//     * less specific than the valid locale.  This method is intended
65//     * for use by factories or other entities that create objects of
66//     * this class.
67//     * @param valid the most specific locale containing any resource
68//     * data, or null
69//     * @param actual the locale containing data used to construct this
70//     * object, or null
71//     * @see com.ibm.icu.util.ULocale
72//     * @see com.ibm.icu.util.ULocale#VALID_LOCALE
73//     * @see com.ibm.icu.util.ULocale#ACTUAL_LOCALE
74//     */
75//    final void setLocale(ULocale valid, ULocale actual) {
76//        throw new UnsupportedOperationException("Method not supported by com.ibm.icu.base");
77//    }
78}
79