Package io.github.erdos.stencil.functions

Enum Class NumberFunctions

java.lang.Object

java.lang.Enum<NumberFunctions>

io.github.erdos.stencil.functions.NumberFunctions

All Implemented Interfaces:

Function, Serializable, Comparable<NumberFunctions>, Constable

public enum NumberFunctions
extends Enum<NumberFunctions>
implements Function

Common numeric functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NumberFunctions.Provider

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CEIL	Rounds a number to the closest bigger integer value.
FLOOR	Rounds a number to the closest smaller integer value.
ROUND	Rounds a number to the nearest integer.

Method Summary

Modifier and Type	Method	Description
String	getName()	Name of the function used as function identifier.
static NumberFunctions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NumberFunctions[]	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

ROUND

public static final NumberFunctions ROUND

Rounds a number to the nearest integer.

Expects 1 argument and returns null on null argument.

CEIL

public static final NumberFunctions CEIL

Rounds a number to the closest bigger integer value.

Expects 1 argument and returns null on null argument.

FLOOR

public static final NumberFunctions FLOOR

Rounds a number to the closest smaller integer value.

Expects 1 argument and returns null on null argument.

Method Details

values

public static NumberFunctions[] 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 NumberFunctions 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