sirius.tagliatelle.macros

Class EnumValuesMacro

java.lang.Object

sirius.tagliatelle.macros.EnumValuesMacro

All Implemented Interfaces:

sirius.kernel.di.std.Named, Macro

public class EnumValuesMacro
extends Object
implements Macro

Returns all values of a given enum class.

Constructor Summary

Constructors

Constructor and Description
EnumValuesMacro()

Method Summary

Modifier and Type	Method and Description
Object	eval(LocalRenderContext ctx, Expression[] args) Evaluates the macro at runtime.
String	getDescription() Provides a short description of what the macro does for documentation purposes.
String	getName()
Class<?>	getType() Returns the type of objects returned by this macro.
boolean	isConstant(Expression[] args) Determines if the macro is "constant" for the given parameter expressions.
void	verifyArguments(List<Expression> args) Verifies the arguments.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sirius.tagliatelle.macros.Macro

dereference

Constructor Detail

EnumValuesMacro

public EnumValuesMacro()

Method Detail

getType

public Class<?> getType()

Description copied from interface: Macro

Returns the type of objects returned by this macro.

Specified by:

getType in interface Macro

Returns:

the type of objects returned by this macro

verifyArguments

public void verifyArguments(List<Expression> args)

Description copied from interface: Macro

Verifies the arguments.

This is used to verify the type and count of arguments at compile time. If one or more arguments are invalid an IllegalArgumentException can be thrown.

Specified by:

verifyArguments in interface Macro

Parameters:

args - the expressions which will be passed in at runtime.

eval

public Object eval(LocalRenderContext ctx,
                   Expression[] args)

Description copied from interface: Macro

Evaluates the macro at runtime.

Note that the arguments are still expressions and have to be evaluated on demand.

Specified by:

eval in interface Macro

Parameters:

ctx - the rendering context

args - the arguments

Returns:

the result of the macro call

isConstant

public boolean isConstant(Expression[] args)

Description copied from interface: Macro

Determines if the macro is "constant" for the given parameter expressions.

Specified by:

isConstant in interface Macro

Parameters:

args - the arguments of the macro

Returns:

true if the function will always yield the same output for the same input, false otherwise.

getName

@Nonnull
public String getName()

Specified by:

getName in interface sirius.kernel.di.std.Named

getDescription

public String getDescription()

Description copied from interface: Macro

Provides a short description of what the macro does for documentation purposes.

Specified by:

getDescription in interface Macro

Returns:

a short description of the macro