Class While

    • Method Detail

      • setTest

        public void setTest​(Expression test)
      • setAction

        public void setAction​(Expression action)
      • operands

        public java.lang.Iterable<Operand> operands()
        Description copied from class: Expression
        Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression. Default implementation works off the results of iterateSubExpressions()

        If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.

        Specified by:
        operands in class Instruction
        an iterator containing the sub-expressions of this expression
      • getInstructionNameCode

        public int getInstructionNameCode()
        Get the name of this instruction for diagnostic and tracing purposes
        getInstructionNameCode in class Instruction
        the string "saxon:while"
      • getActionExpression

        public Expression getActionExpression()
        Get the action expression (the content of the for-each)
      • copy

        public Expression copy​(RebindingMap rebindings)
        Copy an expression. This makes a deep copy.
        Specified by:
        copy in class Expression
        rebindings - variables that need to be re-bound
        the copy of the original expression
      • getItemType

        public ItemType getItemType()
        Get the item type of the items returned by evaluating this instruction
        getItemType in class Instruction
        the static item type of the instruction
      • mayCreateNewNodes

        public final boolean mayCreateNewNodes()
        Determine whether this instruction creates new nodes. This implementation returns true if the "action" creates new nodes. (Nodes created by the condition can't contribute to the result).
        mayCreateNewNodes in class Instruction
        true if the instruction creates new nodes under some input conditions (or if it can't be proved that it doesn't)
      • processLeavingTail

        public TailCall processLeavingTail​(Outputter output,
                                           XPathContext context)
                                    throws XPathException
        Description copied from class: Instruction
        ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.
        Specified by:
        processLeavingTail in interface TailCallReturner
        Specified by:
        processLeavingTail in class Instruction
        output - the destination for the result
        context - The dynamic context of the transformation, giving access to the current node, the current variables, etc.
        null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.
        XPathException - if a dynamic error occurs during the evaluation of the instruction
      • export

        public void export​(ExpressionPresenter out)
                    throws XPathException
        Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
        Specified by:
        export in interface ExportAgent
        Specified by:
        export in class Expression
        out - the expression presenter used to display the structure
        XPathException - if the export fails, for example if an expression is found that won't work in the target environment.