Source for java.text.spi.NumberFormatProvider

   1: /* NumberFormatProvider.java -- Providers of localized instances
   2:    Copyright (C) 2007 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.text.spi;
  39: 
  40: import java.text.NumberFormat;
  41: 
  42: import java.util.Locale;
  43: 
  44: import java.util.spi.LocaleServiceProvider;
  45: 
  46: /**
  47:  * A {@link NumberFormatProvider} provides localized
  48:  * instances of {@link java.text.NumberFormat}.
  49:  *
  50:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  51:  * @since 1.6
  52:  */
  53: public abstract class NumberFormatProvider
  54:   extends LocaleServiceProvider
  55: {
  56: 
  57:   /**
  58:    * Constructs a new {@link NumberFormatProvider}.
  59:    * Provided for implicit invocation by subclasses.
  60:    */
  61:   protected NumberFormatProvider()
  62:   {
  63:   }
  64: 
  65:   /**
  66:    * Returns a {@link java.text.NumberFormat} instance
  67:    * for monetary values in the specified
  68:    * {@link java.util.Locale}.
  69:    *
  70:    * @param locale the desired locale.
  71:    * @return the localized instance for monetary values.
  72:    * @throws NullPointerException if the locale is null.
  73:    * @throws IllegalArgumentException if the locale is not one
  74:    *                                  returned by
  75:    *                                  {@link getAvailableLocales()}
  76:    * @see java.text.NumberFormat#getCurrencyInstance(java.util.Locale)
  77:    */
  78:   public abstract NumberFormat getCurrencyInstance(Locale locale);
  79: 
  80:   /**
  81:    * Returns a {@link java.text.NumberFormat} instance
  82:    * for integers in the specified {@link java.util.Locale}.
  83:    * The returned instance should be configured to round 
  84:    * floating point numbers to the nearest integer using
  85:    * {@link java.math.RoundingMode#HALF_EVEN} rounding,
  86:    * and to parse only the integer part of a number.
  87:    *
  88:    * @param locale the desired locale.
  89:    * @return the localized instance for integers.
  90:    * @throws NullPointerException if the locale is null.
  91:    * @throws IllegalArgumentException if the locale is not one
  92:    *                                  returned by
  93:    *                                  {@link getAvailableLocales()}
  94:    * @see java.text.NumberFormat#getIntegerInstance(java.util.Locale)
  95:    * @see java.math.RoundingMode#HALF_EVEN
  96:    * @see java.text.NumberFormat#isParseIntegerOnly()
  97:    */
  98:   public abstract NumberFormat getIntegerInstance(Locale locale);
  99: 
 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: }