001/* NumberFormatProvider.java -- Providers of localized instances
002   Copyright (C) 2007 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.text.spi;
039
040import java.text.NumberFormat;
041
042import java.util.Locale;
043
044import java.util.spi.LocaleServiceProvider;
045
046/**
047 * A {@link NumberFormatProvider} provides localized
048 * instances of {@link java.text.NumberFormat}.
049 *
050 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
051 * @since 1.6
052 */
053public abstract class NumberFormatProvider
054  extends LocaleServiceProvider
055{
056
057  /**
058   * Constructs a new {@link NumberFormatProvider}.
059   * Provided for implicit invocation by subclasses.
060   */
061  protected NumberFormatProvider()
062  {
063  }
064
065  /**
066   * Returns a {@link java.text.NumberFormat} instance
067   * for monetary values in the specified
068   * {@link java.util.Locale}.
069   *
070   * @param locale the desired locale.
071   * @return the localized instance for monetary values.
072   * @throws NullPointerException if the locale is null.
073   * @throws IllegalArgumentException if the locale is not one
074   *                                  returned by
075   *                                  {@link getAvailableLocales()}
076   * @see java.text.NumberFormat#getCurrencyInstance(java.util.Locale)
077   */
078  public abstract NumberFormat getCurrencyInstance(Locale locale);
079
080  /**
081   * Returns a {@link java.text.NumberFormat} instance
082   * for integers in the specified {@link java.util.Locale}.
083   * The returned instance should be configured to round
084   * floating point numbers to the nearest integer using
085   * {@link java.math.RoundingMode#HALF_EVEN} rounding,
086   * and to parse only the integer part of a number.
087   *
088   * @param locale the desired locale.
089   * @return the localized instance for integers.
090   * @throws NullPointerException if the locale is null.
091   * @throws IllegalArgumentException if the locale is not one
092   *                                  returned by
093   *                                  {@link getAvailableLocales()}
094   * @see java.text.NumberFormat#getIntegerInstance(java.util.Locale)
095   * @see java.math.RoundingMode#HALF_EVEN
096   * @see java.text.NumberFormat#isParseIntegerOnly()
097   */
098  public abstract NumberFormat getIntegerInstance(Locale locale);
099
100  /**
101   * Returns a general-purpose {@link java.text.NumberFormat}
102   * instance in the specified {@link java.util.Locale}.
103   *
104   * @param locale the desired locale.
105   * @return a general-purpose localized instance.
106   * @throws NullPointerException if the locale is null.
107   * @throws IllegalArgumentException if the locale is not one
108   *                                  returned by
109   *                                  {@link getAvailableLocales()}
110   * @see java.text.NumberFormat#getNumberInstance(java.util.Locale)
111   */
112  public abstract NumberFormat getNumberInstance(Locale locale);
113
114  /**
115   * Returns a {@link java.text.NumberFormat} instance
116   * for percentage values in the specified
117   * {@link java.util.Locale}.
118   *
119   * @param locale the desired locale.
120   * @return the localized instance for percentage values.
121   * @throws NullPointerException if the locale is null.
122   * @throws IllegalArgumentException if the locale is not one
123   *                                  returned by
124   *                                  {@link getAvailableLocales()}
125   * @see java.text.NumberFormat#getPercentInstance(java.util.Locale)
126   */
127  public abstract NumberFormat getPercentInstance(Locale locale);
128
129}