org.broadleafcommerce.common.currency.util

Enum BroadleafCurrencyUtils.CurrencyLocation

java.lang.Object

java.lang.Enum<BroadleafCurrencyUtils.CurrencyLocation>

org.broadleafcommerce.common.currency.util.BroadleafCurrencyUtils.CurrencyLocation

All Implemented Interfaces:

Serializable, Comparable<BroadleafCurrencyUtils.CurrencyLocation>

Enclosing class:

BroadleafCurrencyUtils

public static enum BroadleafCurrencyUtils.CurrencyLocation
extends Enum<BroadleafCurrencyUtils.CurrencyLocation>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Uses formatting defined in the selected locale
PREFIX The currency name will always be to the left of the value
SUFFIX The currency name will always be to the right of the value

Method Summary

Modifier and Type	Method and Description
static BroadleafCurrencyUtils.CurrencyLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static BroadleafCurrencyUtils.CurrencyLocation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final BroadleafCurrencyUtils.CurrencyLocation DEFAULT

Uses formatting defined in the selected locale

PREFIX

public static final BroadleafCurrencyUtils.CurrencyLocation PREFIX

The currency name will always be to the left of the value

SUFFIX

public static final BroadleafCurrencyUtils.CurrencyLocation SUFFIX

The currency name will always be to the right of the value

Method Detail

values

public static BroadleafCurrencyUtils.CurrencyLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BroadleafCurrencyUtils.CurrencyLocation c : BroadleafCurrencyUtils.CurrencyLocation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BroadleafCurrencyUtils.CurrencyLocation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null