CurrencySymbolKeys.java

// CurrencySymbolKeys

package org.javamoney.examples.ez.money.locale;

import javax.money.CurrencySupplier;
import javax.money.CurrencyUnit;
import javax.money.Monetary;

import org.javamoney.examples.ez.common.utility.I18NHelper;

/**
 * This enumerated class provides keys for the currency symbols and values.
 */
public
enum
CurrencySymbolKeys implements CurrencySupplier
{
  // Declared in order they should appear in a chooser.
  /**
   * No symbol.
   */
  NONE(I18NHelper.getSharedProperty("none"), "", Monetary.getCurrency("XXX")),
  /**
   * The Euro.
   */
  EURO("\u20ac ", Monetary.getCurrency("EUR")),
  /**
   * The US Dollar.
   */
  DOLLAR("$ ", Monetary.getCurrency("USD")),
  /**
   * The English Pound.
   */
  POUND("\u00a3 ", Monetary.getCurrency("GBP")),
  /**
   * The South African Rand.
   */
  RAND("R ", Monetary.getCurrency("ZAR")),
  /**
   * The Brazilian Real.
   */
  REAL("R$ ", Monetary.getCurrency("BRL")),
  /**
   * The Russian Ruble.
   */
  RUBLE(" \u0440.", Monetary.getCurrency("RUB"));

  //////////////////////////////////////////////////////////////////////////////
  // Start of public methods.
  //////////////////////////////////////////////////////////////////////////////

  /**
   * This method returns a string for the enum constant.
   *
   * @return A string.
   */
  public
  String
  getSymbol()
  {
    return itsSymbol;
  }
  
  /**
   * This method returns a currency unit for the enum constant.
   *
   * @return A currency.
   */
  public
  CurrencyUnit
  getCurrency()
  {
    return itsCurrency;
  }


  /**
   * This method returns the currency symbol.
   *
   * @return The currency symbol.
   */
  @Override
  public
  String
  toString()
  {
    return itsIdentifier;
  }

  //////////////////////////////////////////////////////////////////////////////
  // Start of private methods.
  //////////////////////////////////////////////////////////////////////////////

  private
  CurrencySymbolKeys(String symbol, CurrencyUnit currency)
  {
    this(symbol, symbol, currency);
  }

  private
  CurrencySymbolKeys(String identifier, String symbol, CurrencyUnit currency)
  {
    itsIdentifier = identifier;
    itsSymbol = symbol;
    itsCurrency = currency;
  }

  //////////////////////////////////////////////////////////////////////////////
  // Start of class members.
  //////////////////////////////////////////////////////////////////////////////

  private final String itsIdentifier;
  private final String itsSymbol;
  private final CurrencyUnit itsCurrency;
}