sirius.tagliatelle.macros

Interface Macro

All Superinterfaces:

sirius.kernel.di.std.Named

All Known Implementing Classes:

ApplyMacro, DateComparingMacro, EnumValuesMacro, EscapeJSMacro, FormatDateMacro, FormatMacro, FormatSizeMacro, FormatTimeMacro, I18nMacro, InlineResourceMacro, IsAfterMacro, IsBeforeMacro, IsFilledMacro, IsFrameworkEnabledMacro, JoinMacro, JSONMacro, LeftPadMacro, LimitMacro, MonthNameMacro, RenderBlockMacro, RightPadMacro, SplitAtLastMacro, SplitMacro, ToListMacro, ToMachineStringMacro, ToSpokenDateMacro, ToUserStringMacro, UrlEncodeMacro, XMLMacro

public interface Macro
extends sirius.kernel.di.std.Named

Represents a macro or constant function.

Method Summary

Modifier and Type	Method and Description
default Expression	dereference(Template template, Function<String,Emitter> blocks, Expression[] args) Replaces the call to this macro by an alternative expression if blocks are to be inlined.
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.
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 interface sirius.kernel.di.std.Named

getName

Method Detail

getType

Class<?> getType()

Returns the type of objects returned by this macro.

Returns:

the type of objects returned by this macro

verifyArguments

void verifyArguments(List<Expression> args)

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.

Parameters:

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

eval

Object eval(LocalRenderContext ctx,
            Expression[] args)

Evaluates the macro at runtime.

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

Parameters:

ctx - the rendering context

args - the arguments

Returns:

the result of the macro call

isConstant

boolean isConstant(Expression[] args)

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

Parameters:

args - the arguments of the macro

Returns:

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

getDescription

String getDescription()

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

Returns:

a short description of the macro

dereference

default Expression dereference(Template template,
                               Function<String,Emitter> blocks,
                               Expression[] args)

Replaces the call to this macro by an alternative expression if blocks are to be inlined.

Parameters:

template - the template for which the blocks are dereferenced

blocks - the translator which resolves a block name into an Emitter

args - the macro arguments

Returns:

the replacement expression for this macro call or null to indicate tha the macro doesn't depent on any block