com.whitestein.lsps.stdlib.function

Class EnumerationFunctions

java.lang.Object

com.whitestein.lsps.stdlib.function.EnumerationFunctions

public class EnumerationFunctions
extends Object

Functions for enumerations.

Author:

bhl

Constructor Summary

Constructors

Constructor and Description
EnumerationFunctions() Creates new instance.

Method Summary

Modifier and Type	Method and Description
ListHolder	literals(ExecutionContext ctx, Type enumeration) Returns a list of literals from the specified enumeration.
String	literalToName(ExecutionContext ctx, EnumerationImpl enumeration) Transforms the specified enumeration literal to its name represented as string.
EnumerationImpl	nameToLiteral(ExecutionContext ctx, Type enumeration, String name) Transforms the specified enumeration’s literal name to the corresponding literal value.
EnumerationImpl	toEnumeration(ExecutionContext ctx, String string) Parses a given enumeration full name into enumeration object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnumerationFunctions

public EnumerationFunctions()

Creates new instance.

Method Detail

literals

public ListHolder literals(ExecutionContext ctx,
                           Type enumeration)
                    throws ErrorException

Returns a list of literals from the specified enumeration.

Parameters:

ctx -

enumeration -

Returns:

list of literals from the specified enumeration

Throws:

ErrorException

literalToName

public String literalToName(ExecutionContext ctx,
                            EnumerationImpl enumeration)
                     throws ErrorException

Transforms the specified enumeration literal to its name represented as string.

Parameters:

ctx -

enumeration -

Returns:

string representation of the enumeration literal

Throws:

ErrorException

nameToLiteral

public EnumerationImpl nameToLiteral(ExecutionContext ctx,
                                     Type enumeration,
                                     String name)
                              throws ErrorException

Transforms the specified enumeration’s literal name to the corresponding literal value.

Parameters:

ctx -

enumeration -

name -

Returns:

enumeration literal valueO

Throws:

ErrorException

toEnumeration

public EnumerationImpl toEnumeration(ExecutionContext ctx,
                                     String string)
                              throws ErrorException

Parses a given enumeration full name into enumeration object.

Parameters:

ctx -

string -

Returns:

enumeration

Throws:

ErrorException