org.apache.xpath.functions
Class Function2Args

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

Direct Known Subclasses:

FuncContains, FuncDocument, FuncKey, FuncStartsWith, FuncSubstringAfter, FuncSubstringBefore, Function3Args

public class Function2Args

extends FunctionOneArg

**For advanced use only** Base class for functions that accept two arguments.

See Also:

Serialized Form

Constructor Summary

Function2Args()

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.
Expression	getArg1() Return the second argument passed to the function (at index 1).
void	setArg(Expression arg, int argNum) Set an argument expression for a function.

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

Function2Args

public Function2Args()

Method Detail

getArg1

public Expression getArg1()

Return the second argument passed to the function (at index 1).

Returns:

An expression that represents the second argument passed to the function.

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 the argNum parameter is greater than 1.

Overrides:

setArg in class FunctionOneArg

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 FunctionOneArg

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 FunctionOneArg