Source for java.util.spi.CurrencyNameProvider

   1: /* CurrencyNameProvider.java -- Providers of localized currency symbols
   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.util.spi;
  39: 
  40: import java.util.Locale;
  41: 
  42: /**
  43:  * A {@link CurrencyNameProvider} provides localized
  44:  * versions of the symbols that represent a particular
  45:  * currency.  Note that currency symbols are regarded
  46:  * as names, and thus a <code>null</code> value may
  47:  * be returned, which should be treated as a lack of
  48:  * support for the specified {@link Locale}.
  49:  *
  50:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  51:  * @since 1.6
  52:  */
  53: public abstract class CurrencyNameProvider
  54:   extends LocaleServiceProvider
  55: {
  56: 
  57:   /**
  58:    * Constructs a new {@link CurrencyNameProvider}.
  59:    * Provided for implicit invocation by subclasses.
  60:    */
  61:   protected CurrencyNameProvider()
  62:   {
  63:   }
  64: 
  65:   /**
  66:    * <p>
  67:    * This method returns the symbol which precedes or follows a
  68:    * value in this particular currency.  The returned value is
  69:    * the symbol used to denote the currency in the specified locale.
  70:    * </p>
  71:    * <p>
  72:    * For example, a supplied locale may specify a different symbol
  73:    * for the currency, due to conflicts with its own currency.
  74:    * This would be the case with the American currency, the dollar.
  75:    * Locales that also use a dollar-based currency (e.g. Canada, Australia)
  76:    * need to differentiate the American dollar using 'US$' rather than '$'.
  77:    * So, supplying one of these locales to <code>getSymbol()</code> would
  78:    * return this value, rather than the standard '$'.
  79:    * </p>
  80:    * <p>
  81:    * In cases where there is no such symbol for a particular currency,
  82:    * <code>null</code> should be returned.
  83:    * </p>
  84:    *
  85:    * @param currencyCode the ISO 4217 currency code, consisting
  86:    *                     of three uppercase letters from 'A' to 'Z'
  87:    * @param locale the locale to express the symbol in.
  88:    * @return the currency symbol, or <code>null</code> if one is
  89:    *         unavailable.
  90:    * @throws NullPointerException if the locale is null.
  91:    * @throws IllegalArgumentException if the currency code is
  92:    *                                  not in the correct format
  93:    *                                  or the locale is not one
  94:    *                                  returned by
  95:    *                                  {@link getAvailableLocales()}
  96:    * @see java.util.Currency#getSymbol(java.util.Locale)
  97:    */
  98:   public abstract String getSymbol(String currencyCode, Locale locale);
  99: 
 100: }