sirius.tagliatelle.macros

Class DateComparingMacro

java.lang.Object

sirius.tagliatelle.macros.DateComparingMacro

All Implemented Interfaces:

sirius.kernel.di.std.Named, Macro

Direct Known Subclasses:

IsAfterMacro, IsBeforeMacro

public abstract class DateComparingMacro
extends Object
implements Macro

Basic class for macros handling date comparison

Constructor Summary

Constructors

Constructor and Description
DateComparingMacro()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	compare(LocalDateTime firstDate, LocalDateTime secondDate)
Object	eval(LocalRenderContext ctx, Expression[] args) Evaluates the macro at runtime.
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.
protected LocalDateTime	parseInput(Object object)
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, getDescription

Methods inherited from interface sirius.kernel.di.std.Named

getName

Constructor Detail

DateComparingMacro

public DateComparingMacro()

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

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.

parseInput

protected LocalDateTime parseInput(Object object)

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

compare

protected abstract boolean compare(LocalDateTime firstDate,
                                   LocalDateTime secondDate)

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.