1 /*
   2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.text.spi;
  27 
  28 import java.text.DecimalFormatSymbols;
  29 import java.util.Locale;
  30 import java.util.spi.LocaleServiceProvider;
  31 
  32 /**
  33  * An abstract class for service providers that
  34  * provide instances of the
  35  * {@link java.text.DecimalFormatSymbols DecimalFormatSymbols} class.
  36  *
  37  * <p>The requested {@code Locale} may contain an <a
  38  * href="../../util/Locale.html#def_locale_extension"> extension</a> for
  39  * specifying the desired numbering system. For example, {@code "ar-u-nu-arab"}
  40  * (in the BCP 47 language tag form) specifies Arabic with the Arabic-Indic
  41  * digits and symbols, while {@code "ar-u-nu-latn"} specifies Arabic with the
  42  * Latin digits and symbols. Refer to the <em>Unicode Locale Data Markup
  43  * Language (LDML)</em> specification for numbering systems.
  44  *
  45  * @since        1.6
  46  * @see Locale#forLanguageTag(String)
  47  * @see Locale#getExtension(char)
  48  */
  49 public abstract class DecimalFormatSymbolsProvider extends LocaleServiceProvider {
  50 
  51     /**
  52      * Sole constructor.  (For invocation by subclass constructors, typically
  53      * implicit.)
  54      */
  55     protected DecimalFormatSymbolsProvider() {
  56     }
  57 
  58     /**
  59      * Returns a new <code>DecimalFormatSymbols</code> instance for the
  60      * specified locale.
  61      *
  62      * @param locale the desired locale
  63      * @exception NullPointerException if <code>locale</code> is null
  64      * @exception IllegalArgumentException if <code>locale</code> isn't
  65      *     one of the locales returned from
  66      *     {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
  67      *     getAvailableLocales()}.
  68      * @return a <code>DecimalFormatSymbols</code> instance.
  69      * @see java.text.DecimalFormatSymbols#getInstance(java.util.Locale)
  70      */
  71     public abstract DecimalFormatSymbols getInstance(Locale locale);
  72 }