org.quattor.pan.dml.functions
Class Return

java.lang.Object
  org.quattor.pan.dml.AbstractOperation
      org.quattor.pan.dml.functions.BuiltInFunction
          org.quattor.pan.dml.functions.Return

All Implemented Interfaces:

Operation

public final class Return
extends BuiltInFunction

Sets the result of a DML block to the function's argument and immediately leaves the innermost function call or DML block.

Author:

loomis

Field Summary

Fields inherited from class org.quattor.pan.dml.functions.BuiltInFunction

name

Fields inherited from class org.quattor.pan.dml.AbstractOperation

ops, sourceRange

Method Summary

void	checkRestrictedContext() Default implementation recursively calls this method on all of the contained operations (arguments).
Element	execute(Context context) Execute this operation within the given context.
static Operation	getInstance(SourceRange sourceRange, Operation... operations)

Methods inherited from class org.quattor.pan.dml.functions.BuiltInFunction

throwExceptionIfCompileTimeContext, toString

Methods inherited from class org.quattor.pan.dml.AbstractOperation

calculateArgs, calculateTerms, checkInvalidSelfContext, getOperations, getSourceRange

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Operation getInstance(SourceRange sourceRange,
                                    Operation... operations)
                             throws SyntaxException

Throws:

SyntaxException

execute

public Element execute(Context context)

Description copied from interface: Operation

Execute this operation within the given context. If an error occurs, an EvaluationException will be thrown with the details.

Specified by:

execute in interface Operation

Specified by:

execute in class AbstractOperation

Parameters:

context - evaluation context for the statement

Returns:

Element produced by running operation

checkRestrictedContext

public void checkRestrictedContext()
                            throws SyntaxException

Description copied from class: AbstractOperation

Default implementation recursively calls this method on all of the contained operations (arguments). Subclasses that cannot appear in a restricted context (array indices or function arguments) should override this method and throw a SyntaxException.

Specified by:

checkRestrictedContext in interface Operation

Overrides:

checkRestrictedContext in class AbstractOperation

Throws:

SyntaxException - if operation cannot appear in restricted context