net.sourceforge.htmlunit.xpath.functions

Class FuncSubstring

java.lang.Object

net.sourceforge.htmlunit.xpath.Expression

net.sourceforge.htmlunit.xpath.functions.Function

net.sourceforge.htmlunit.xpath.functions.FunctionOneArg

net.sourceforge.htmlunit.xpath.functions.Function2Args

net.sourceforge.htmlunit.xpath.functions.Function3Args

net.sourceforge.htmlunit.xpath.functions.FuncSubstring

All Implemented Interfaces:

SourceLocator, ExpressionNode, XPathVisitable

public class FuncSubstring
extends Function3Args

Execute the Substring() function.

Constructor Summary

Constructors

Constructor and Description
FuncSubstring()

Method Summary

Modifier and Type	Method and Description
void	checkNumberArgs(int argNum) Check that the number of arguments passed to this function is correct.
XObject	execute(XPathContext xctxt) Execute an expression in the XPath runtime context, and return the result of the expression.
protected void	reportWrongNumberArgs() Constructs and throws a WrongNumberArgException with the appropriate message for this function object.

Methods inherited from class net.sourceforge.htmlunit.xpath.functions.Function3Args

callArgVisitors, canTraverseOutsideSubtree, deepEquals, setArg

Methods inherited from class net.sourceforge.htmlunit.xpath.functions.Function

callVisitors, postCompileStep

Methods inherited from class net.sourceforge.htmlunit.xpath.Expression

asIterator, asNode, assertion, bool, error, execute, execute, execute, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isSameClass, isStableNumber, num

Methods inherited from class java.lang.Object

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

Constructor Detail

FuncSubstring

public FuncSubstring()

Method Detail

execute

public XObject execute(XPathContext xctxt)
                throws TransformerException

Execute an expression in the XPath runtime context, and return the result of the expression.

Overrides:

execute in class Function

Parameters:

xctxt - The XPath runtime context.

Returns:

The result of the expression in the form of a XObject.

Throws:

TransformerException - if a runtime exception occurs.

checkNumberArgs

public void checkNumberArgs(int argNum)
                     throws WrongNumberArgsException

Check that the number of arguments passed to this function is correct. This method is meant to be overloaded by derived classes, to check for the number of arguments for a specific function type. This method is called by the compiler for static number of arguments checking.

Overrides:

checkNumberArgs in class Function3Args

Parameters:

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

Throws:

WrongNumberArgsException - if any

reportWrongNumberArgs

protected void reportWrongNumberArgs()
                              throws WrongNumberArgsException

Constructs and throws a WrongNumberArgException with the appropriate message for this function object. This method is meant to be overloaded by derived classes so that the message will be as specific as possible.

Overrides:

reportWrongNumberArgs in class Function3Args

Throws:

WrongNumberArgsException - if any