org.apache.xpath.functions
Class FunctionMultiArgs

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.functions.Function
              |
              +--org.apache.xpath.functions.FunctionOneArg
                    |
                    +--org.apache.xpath.functions.Function2Args
                          |
                          +--org.apache.xpath.functions.Function3Args
                                |
                                +--org.apache.xpath.functions.FunctionMultiArgs

Direct Known Subclasses:

FuncConcat

public class FunctionMultiArgs

extends Function3Args

**For advanced use only** Base class for functions that accept an undetermined number of multiple arguments.

See Also:

Serialized Form

Constructor Summary

FunctionMultiArgs()

Method Summary

boolean	canTraverseOutsideSubtree() Tell if this expression or it's subexpressions can traverse outside the current subtree.
void	checkNumberArgs(int argNum) Check that the number of arguments passed to this function is correct.
void	setArg(Expression arg, int argNum) Set an argument expression for a function.

Methods inherited from class org.apache.xpath.functions.Function3Args

getArg2

Methods inherited from class org.apache.xpath.functions.Function2Args

getArg1

Methods inherited from class org.apache.xpath.functions.FunctionOneArg

getArg0

Methods inherited from class org.apache.xpath.functions.Function

execute

Methods inherited from class org.apache.xpath.Expression

assert, error, setSourceLocator, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionMultiArgs

public FunctionMultiArgs()

Method Detail

setArg

public void setArg(Expression arg,
                   int argNum)
            throws WrongNumberArgsException

Set an argument expression for a function. This method is called by the XPath compiler.

Parameters:

arg - non-null expression that represents the argument.

argNum - The argument number index.

Throws:

WrongNumberArgsException - If a derived class determines that the number of arguments is incorrect.

Overrides:

setArg in class Function3Args

checkNumberArgs

public void checkNumberArgs(int argNum)
                     throws WrongNumberArgsException

Check that the number of arguments passed to this function is correct.

Parameters:

argNum - The number of arguments that is being passed to the function.

Throws:

WrongNumberArgsException -

Overrides:

checkNumberArgs in class Function3Args

canTraverseOutsideSubtree

public boolean canTraverseOutsideSubtree()

Tell if this expression or it's subexpressions can traverse outside the current subtree.

Returns:

true if traversal outside the context node's subtree can occur.

Overrides:

canTraverseOutsideSubtree in class Function3Args