Package io.github.erdos.stencil.functions

Enum Class BasicFunctions

java.lang.Object

java.lang.Enum<BasicFunctions>

io.github.erdos.stencil.functions.BasicFunctions

All Implemented Interfaces:

Function, Serializable, Comparable<BasicFunctions>, Constable

public enum BasicFunctions
extends Enum<BasicFunctions>
implements Function

Common general purpose functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicFunctions.Provider

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COALESCE	Returns the first non-null a non-empty value.
EMPTY	Returns true iff input is null, empty string or empty collection.
SWITCH	Selects value based on first argument.

Method Summary

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

SWITCH

public static final BasicFunctions SWITCH

Selects value based on first argument. Usage: switch(expression, case-1, value-1, case-2, value-2, ..., optional-default-value)

COALESCE

public static final BasicFunctions COALESCE

Returns the first non-null a non-empty value.

Accepts any arguments. Skips null values, empty strings and empty collections.

EMPTY

public static final BasicFunctions EMPTY

Returns true iff input is null, empty string or empty collection.

Expects exactly 1 argument.

Method Details

values

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