Class ExpressionFunction

java.lang.Object

com.blackrook.expression.node.ExpressionFunction

All Implemented Interfaces:

ExpressionNode

public class ExpressionFunction
extends Object
implements ExpressionNode

Single expression function.

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method	Description
static ExpressionFunction	create(ExpressionFunctionType type)	Creates a new Expression function.
boolean	execute(ExpressionStack stack, ExpressionVariableContext context)	Executes this node.
boolean	isCollapsable()	Checks if this node is collapsable.
String	toString()
void	writeBytes(OutputStream out)	Write value as bytes (for digest later).

Methods inherited from class Object

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

Method Details

create

public static ExpressionFunction create(ExpressionFunctionType type)

Creates a new Expression function.

Parameters:

type - the function type.

Returns:

a new expression directive.

isCollapsable

public boolean isCollapsable()

Description copied from interface: ExpressionNode

Checks if this node is collapsable.

Specified by:

isCollapsable in interface ExpressionNode

Returns:

true if so, false if not.

execute

public boolean execute(ExpressionStack stack,
 ExpressionVariableContext context)

Description copied from interface: ExpressionNode

Executes this node.

Specified by:

execute in interface ExpressionNode

Parameters:

stack - the stack to use.

context - the context for added variables.

Returns:

if false, stop expression calculation, else if true, continue.

writeBytes

public void writeBytes(OutputStream out)
                throws IOException

Description copied from interface: ExpressionNode

Write value as bytes (for digest later).

Specified by:

writeBytes in interface ExpressionNode

Parameters:

out - the output stream.

Throws:

IOException - on a write error.

toString

public String toString()

Overrides:

toString in class Object