Package io.github.erdos.stencil.functions

Enum StringFunctions

java.lang.Object

java.lang.Enum<StringFunctions>

io.github.erdos.stencil.functions.StringFunctions

All Implemented Interfaces:

Function, java.io.Serializable, java.lang.Comparable<StringFunctions>

public enum StringFunctions
extends java.lang.Enum<StringFunctions>
implements Function

Common string functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringFunctions.Provider

Enum Constant Summary

Enum Constants

Enum Constant	Description
JOIN
LOWERCASE	Returns lowercase string of input.
STR	Converts parameters to strings and concatenates the result.
TITLECASE	Converts Every First Letter Of Every Word To Upper Case.
UPPERCASE	Returns UPPERCASE string of input.

Method Summary

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

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

call

Enum Constant Detail

JOIN

public static final StringFunctions JOIN

STR

public static final StringFunctions STR

Converts parameters to strings and concatenates the result. Returns empty string on empty or null arguments.

LOWERCASE

public static final StringFunctions LOWERCASE

Returns lowercase string of input. Expects 1 argument. Returns null on null input.

UPPERCASE

public static final StringFunctions UPPERCASE

Returns UPPERCASE string of input. Expects 1 argument. Returns null on null input.

TITLECASE

public static final StringFunctions TITLECASE

Converts Every First Letter Of Every Word To Upper Case. Expects 1 argument. Returns null on null input.

Method Detail

values

public static StringFunctions[] 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 (StringFunctions c : StringFunctions.values())
    System.out.println(c);

Returns:

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

valueOf

public static StringFunctions valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getName

public java.lang.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