Package org.htmlunit.xpath.functions
Class Function3Args
- java.lang.Object
-
- org.htmlunit.xpath.Expression
-
- org.htmlunit.xpath.functions.Function
-
- org.htmlunit.xpath.functions.FunctionOneArg
-
- org.htmlunit.xpath.functions.Function2Args
-
- org.htmlunit.xpath.functions.Function3Args
-
- All Implemented Interfaces:
javax.xml.transform.SourceLocator
,ExpressionNode
,XPathVisitable
- Direct Known Subclasses:
FuncSubstring
,FunctionMultiArgs
,FuncTranslate
public class Function3Args extends Function2Args
Base class for functions that accept three arguments.
-
-
Field Summary
Fields Modifier and Type Field Description (package private) Expression
arg2_
The third argument passed to the function (at index 2).-
Fields inherited from class org.htmlunit.xpath.functions.Function2Args
m_arg1
-
Fields inherited from class org.htmlunit.xpath.functions.FunctionOneArg
m_arg0
-
-
Constructor Summary
Constructors Constructor Description Function3Args()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
callArgVisitors(XPathVisitor visitor)
Call the visitors for the function arguments.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.boolean
deepEquals(Expression expr)
Compare this object with another object and see if they are equal, include the sub heararchy.protected void
reportWrongNumberArgs()
Constructs and throws a WrongNumberArgException with the appropriate message for this function object.void
setArg(Expression arg, int argNum)
Set an argument expression for a function.-
Methods inherited from class org.htmlunit.xpath.functions.Function
callVisitors, execute, postCompileStep
-
Methods inherited from class org.htmlunit.xpath.Expression
asIterator, asNode, assertion, bool, error, execute, execute, execute, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isSameClass, isStableNumber, num
-
-
-
-
Field Detail
-
arg2_
Expression arg2_
The third argument passed to the function (at index 2).
-
-
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.- Overrides:
setArg
in classFunction2Args
- Parameters:
arg
- non-null expression that represents the argument.argNum
- The argument number index.- Throws:
WrongNumberArgsException
- If the argNum parameter is beyond what is specified for this function.
-
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 classFunction2Args
- 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 classFunction2Args
- Throws:
WrongNumberArgsException
- if any
-
canTraverseOutsideSubtree
public boolean canTraverseOutsideSubtree()
Tell if this expression or it's subexpressions can traverse outside the current subtree.- Overrides:
canTraverseOutsideSubtree
in classFunction2Args
- Returns:
- true if traversal outside the context node's subtree can occur.
-
callArgVisitors
public void callArgVisitors(XPathVisitor visitor)
Call the visitors for the function arguments.- Overrides:
callArgVisitors
in classFunction2Args
-
deepEquals
public boolean deepEquals(Expression expr)
Compare this object with another object and see if they are equal, include the sub heararchy.- Overrides:
deepEquals
in classFunction2Args
- Parameters:
expr
- Another expression object.- Returns:
- true if this objects class and the expr object's class are the same, and the data contained within both objects are considered equal.
-
-