Package io.github.erdos.stencil.functions

Enum Class LocaleFunctions

java.lang.Object

java.lang.Enum<LocaleFunctions>

io.github.erdos.stencil.functions.LocaleFunctions

All Implemented Interfaces:

Function, Serializable, Comparable<LocaleFunctions>, Constable

public enum LocaleFunctions
extends Enum<LocaleFunctions>
implements Function

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocaleFunctions.Provider

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CURRENCY	Formats number as a localized monetary amount with currency.
PERCENT	Formats number as a localized percentage value.

Method Summary

Modifier and Type	Method	Description
String	getName()	Name of the function used as function identifier.
static LocaleFunctions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LocaleFunctions[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.erdos.stencil.functions.Function

call

Enum Constant Details

CURRENCY

public static final LocaleFunctions CURRENCY

Formats number as a localized monetary amount with currency. An optional second argument can be used to specify locale code. Returns a string.

Usage: currency(34) or currency(34, "HU")

PERCENT

public static final LocaleFunctions PERCENT

Formats number as a localized percentage value. An optional second argument can be used to specify locale code. Returns a string.

Usage: percent(34) or percent(34, "HU")

Method Details

values

public static LocaleFunctions[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LocaleFunctions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Description copied from interface: Function

Name of the function used as function identifier.

Must not contain whitespaces. Must not be empty. Must not change. It is used to look up the function from the template file.

Specified by:

getName in interface Function

Returns:

function identifier