BEA Systems, Inc.

WebLogic Server 6.1 API Reference

weblogic.apache.xpath.functions
Class Function2Args

java.lang.Object
  |
  +--weblogic.apache.xpath.Expression
        |
        +--weblogic.apache.xpath.functions.Function
              |
              +--weblogic.apache.xpath.functions.FunctionOneArg
                    |
                    +--weblogic.apache.xpath.functions.Function2Args
Direct Known Subclasses:
FuncContains, FuncDocument, FuncKey, FuncStartsWith, FuncSubstringAfter, FuncSubstringBefore, Function3Args

public class Function2Args
extends FunctionOneArg

Base class for functions that accept two arguments.

This class is based on an implementation from the Apache XML Project. In future releases the XML parser, XSLT processor, and associated classes will likely be updated to be based on a later version of the Apache implementations. Since Apache does not guarantee backwards compatibility between versions of their software, we cannot guarantee backwards compatibility of any of the classes contained in the weblogic.apache package or sub-packages.

See Also:
Serialized Form

Fields inherited from class weblogic.apache.xpath.Expression
m_slocator
 
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 weblogic.apache.xpath.functions.FunctionOneArg
getArg0
 
Methods inherited from class weblogic.apache.xpath.functions.Function
execute
 
Methods inherited from class weblogic.apache.xpath.Expression
assert, error, setSourceLocator, warn
 
Methods inherited from class java.lang.Object
clone, equals, finalize, 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

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs61

WebLogic classes and methods that do not appear in this reference are not public and are not supported.