Top Description Inners Fields Constructors Methods
com.sun.org.apache.xpath.internal.functions

public Class FunctionMultiArgs

extends Function3Args
Class Inheritance
Known Direct Subclasses
com.sun.org.apache.xpath.internal.functions.FuncConcat
Imports
com.sun.org.apache.xalan.internal.res.XSLMessages, com.sun.org.apache.xml.internal.utils.QName, com.sun.org.apache.xpath.internal.Expression, .ExpressionOwner, .XPathVisitor, com.sun.org.apache.xpath.internal.res.XPATHErrorResources, java.util.List
Base class for functions that accept an undetermined number of multiple arguments.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class
FunctionMultiArgs.ArgMultiOwner

Field Summary

Modifier and TypeField and Description
pack-priv Expression[]
m_args

Argument expressions that are at index 3 or greater.

pack-priv static final long
serialVersionUID

Hides com.sun.org.apache.xpath.internal.functions.Function3Args.serialVersionUID.

Inherited from com.sun.org.apache.xpath.internal.functions.Function3Args:
m_arg2

Constructor Summary

AccessConstructor and Description
public
FunctionMultiArgs()

Method Summary

Modifier and TypeMethod and Description
public void
callArgVisitors(XPathVisitor visitor)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.callArgVisitors.

Call the visitors for the function arguments.

public boolean

Returns:

true if traversal outside the context node's subtree can occur.
canTraverseOutsideSubtree()

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.canTraverseOutsideSubtree.

Tell if this expression or it's subexpressions can traverse outside the current subtree.

public void
checkNumberArgs(int
The number of arguments that is being passed to the function.
argNum)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.checkNumberArgs.

Check that the number of arguments passed to this function is correct.

public boolean
deepEquals(Expression
Another expression object.
expr)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.deepEquals.

Compare this object with another object and see if they are equal, include the sub heararchy.

public void
fixupVariables(List<QName>
List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).
vars, int globalsSize)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.fixupVariables.

This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.

public Expression[]

Returns:

An array that contains the arguments at index 3 or greater.
getArgs()

Return an expression array containing arguments at index 3 or greater.

protected void
reportWrongNumberArgs()

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.reportWrongNumberArgs.

Constructs and throws a WrongNumberArgException with the appropriate message for this function object.

public void
setArg(Expression
non-null expression that represents the argument.
arg, int
The argument number index.
argNum)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.setArg.

Set an argument expression for a function.

Inherited from com.sun.org.apache.xpath.internal.functions.Function3Args:
getArg2

Field Detail

m_argsback to summary
pack-priv Expression[] m_args

Argument expressions that are at index 3 or greater.

serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides com.sun.org.apache.xpath.internal.functions.Function3Args.serialVersionUID.

Constructor Detail

FunctionMultiArgsback to summary
public FunctionMultiArgs()

Method Detail

callArgVisitorsback to summary
public void callArgVisitors(XPathVisitor visitor)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.callArgVisitors.

Doc from com.sun.org.apache.xpath.internal.functions.Function.callArgVisitors.

Call the visitors for the function arguments.

See Also
com.sun.org.apache.xpath.internal.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
canTraverseOutsideSubtreeback to summary
public boolean canTraverseOutsideSubtree()

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.canTraverseOutsideSubtree.

Tell if this expression or it's subexpressions can traverse outside the current subtree.

Returns:boolean

true if traversal outside the context node's subtree can occur.

checkNumberArgsback to summary
public void checkNumberArgs(int argNum) throws WrongNumberArgsException

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.checkNumberArgs.

Check that the number of arguments passed to this function is correct.

Parameters
argNum:int

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

deepEqualsback to summary
public boolean deepEquals(Expression expr)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.deepEquals.

Doc from com.sun.org.apache.xpath.internal.Expression.deepEquals.

Compare this object with another object and see if they are equal, include the sub heararchy.

Parameters
expr:Expression

Another expression object.

Returns:boolean

true if this objects class and the expr object's class are the same, and the data contained within both objects are considered equal.

See Also
Expression#deepEquals(Expression)
fixupVariablesback to summary
public void fixupVariables(List<QName> vars, int globalsSize)

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.fixupVariables.

This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.

Parameters
vars:List<QName>

List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).

getArgsback to summary
public Expression[] getArgs()

Return an expression array containing arguments at index 3 or greater.

Returns:Expression[]

An array that contains the arguments at index 3 or greater.

reportWrongNumberArgsback to summary
protected void reportWrongNumberArgs() throws WrongNumberArgsException

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.reportWrongNumberArgs.

Constructs and throws a WrongNumberArgException with the appropriate message for this function object. This class supports an arbitrary number of arguments, so this method must never be called.

setArgback to summary
public void setArg(Expression arg, int argNum) throws WrongNumberArgsException

Overrides com.sun.org.apache.xpath.internal.functions.Function3Args.setArg.

Set an argument expression for a function. This method is called by the XPath compiler.

Parameters
arg:Expression

non-null expression that represents the argument.

argNum:int

The argument number index.

Exceptions
WrongNumberArgsException:
If a derived class determines that the number of arguments is incorrect.
com.sun.org.apache.xpath.internal.functions back to summary

pack-priv Class FunctionMultiArgs.ArgMultiOwner

extends Object
implements ExpressionOwner
Class Inheritance
  • java.lang.Object
  • com.sun.org.apache.xpath.internal.functions.FunctionMultiArgs.ArgMultiOwner
All Implemented Interfaces
com.sun.org.apache.xpath.internal.ExpressionOwner

Field Summary

Modifier and TypeField and Description
pack-priv int
m_argIndex

Constructor Summary

AccessConstructor and Description
pack-priv
ArgMultiOwner(int index)

Method Summary

Modifier and TypeMethod and Description
public Expression
getExpression()

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.getExpression.

Get the raw Expression object that this class wraps.

public void
setExpression(Expression
the raw Expression object, which should not normally be null.
exp)

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.setExpression.

Set the raw expression object for this object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

m_argIndexback to summary
pack-priv int m_argIndex

Constructor Detail

ArgMultiOwnerback to summary
pack-priv ArgMultiOwner(int index)

Method Detail

getExpressionback to summary
public Expression getExpression()

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.getExpression.

Doc from com.sun.org.apache.xpath.internal.ExpressionOwner.getExpression.

Get the raw Expression object that this class wraps.

Returns:Expression

the raw Expression object, which should not normally be null.

See Also
ExpressionOwner#getExpression()
setExpressionback to summary
public void setExpression(Expression exp)

Implements com.sun.org.apache.xpath.internal.ExpressionOwner.setExpression.

Doc from com.sun.org.apache.xpath.internal.ExpressionOwner.setExpression.

Set the raw expression object for this object.

Parameters
exp:Expression

the raw Expression object, which should not normally be null.

See Also
ExpressionOwner#setExpression(Expression)