001/**
002 * Copyright (c) 2012, 2014, Credit Suisse (Anatole Tresch), Werner Keil and others by the @author tag.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005 * use this file except in compliance with the License. You may obtain a copy of
006 * the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013 * License for the specific language governing permissions and limitations under
014 * the License.
015 */
016package org.javamoney.moneta.format;
017
018
019
020/**
021 * Defines the different variants of currency formatting.
022 * 
023 * @author Anatole Tresch
024 * @author Werner Keil
025 */
026public enum CurrencyStyle {
027
028        /**
029         * The currency will be rendered as its (non localized) currency code.
030         * 
031         * @see javax.money.CurrencyUnit#getCurrencyCode()
032         */
033        CODE,
034
035        /**
036         * The currency will be rendered as its localized display name. If no display
037         * name is known for the required {@link javax.money.CurrencyUnit}, the currency code
038         * should be used as a fall-back.
039         * 
040         * @see javax.money.CurrencyUnit#getCurrencyCode()
041         * @see java.util.Currency#getDisplayName(java.util.Locale)
042         */
043        NAME,
044
045        /**
046         * The currency will be rendered as its (non localized) numeric code.
047         * 
048         * @see javax.money.CurrencyUnit#getNumericCode()
049         */
050        NUMERIC_CODE,
051
052        /**
053         * The currency will be rendered as its localized currency symbol. If no
054         * symbol name is known for the required {@link javax.money.CurrencyUnit}, the currency
055         * code should be used as a fall-back.
056         * 
057         * @see javax.money.CurrencyUnit#getCurrencyCode()
058         * @see java.util.Currency#getSymbol(java.util.Locale)
059         */
060        SYMBOL
061}