org.apache.xpath.functions
Class FunctionDef1Arg

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

Direct Known Subclasses:

FuncDoclocation, FuncGenerateId, FuncLocalPart, FuncNamespace, FuncNormalizeSpace, FuncNumber, FuncQname, FuncString, FuncStringLength

public class FunctionDef1Arg

extends FunctionOneArg

**For advanced use only** Base class for functions that accept one argument that can be defaulted if not specified.

See Also:

Serialized Form

Constructor Summary

FunctionDef1Arg()

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.

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

getArg0, setArg

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

FunctionDef1Arg

public FunctionDef1Arg()

Method Detail

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 - if the number of arguments is not 0 or 1.

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