org.apache.xpath

Class Arg

public class Arg extends Object

This class holds an instance of an argument on the stack. The value of the argument can be either an XObject or a String containing an expression.

UNKNOWN: internal

Constructor Summary
Arg()
Construct a dummy parameter argument, with no QName and no value (either expression string or value XObject). isVisible defaults to true.
Arg(QName qname, String expression, boolean isFromWithParam)
Construct a parameter argument that contains an expression.
Arg(QName qname, XObject val)
Construct a parameter argument which has an XObject value. isVisible defaults to true.
Arg(QName qname, XObject val, boolean isFromWithParam)
Construct a parameter argument.
Method Summary
voiddetach()
Have the object release it's resources.
booleanequals(Object obj)
Equality function specialized for the variable name.
StringgetExpression()
Get the value expression for this argument.
QNamegetQName()
Get the qualified name for this argument.
XObjectgetVal()
Get the value for this argument.
booleanisFromWithParam()
Tell if this variable is a parameter passed with a with-param or as a top-level parameter.
booleanisVisible()
Tell if this variable is currently visible.
voidsetExpression(String expr)
Set the value expression for this argument.
voidsetIsVisible(boolean b)
Update visibility status of this variable.
voidsetQName(QName name)
Set the qualified name for this argument.
voidsetVal(XObject val)
Set the value of this argument.

Constructor Detail

Arg

public Arg()
Construct a dummy parameter argument, with no QName and no value (either expression string or value XObject). isVisible defaults to true.

Arg

public Arg(QName qname, String expression, boolean isFromWithParam)
Construct a parameter argument that contains an expression.

Parameters: qname Name of the argument, expressed as a QName object. expression String to be stored as this argument's value expression. isFromWithParam True if this is a parameter variable.

Arg

public Arg(QName qname, XObject val)
Construct a parameter argument which has an XObject value. isVisible defaults to true.

Parameters: qname Name of the argument, expressed as a QName object. val Value of the argument, expressed as an XObject

Arg

public Arg(QName qname, XObject val, boolean isFromWithParam)
Construct a parameter argument.

Parameters: qname Name of the argument, expressed as a QName object. val Value of the argument, expressed as an XObject isFromWithParam True if this is a parameter variable.

Method Detail

detach

public void detach()
Have the object release it's resources. Call only when the variable or argument is going out of scope.

equals

public boolean equals(Object obj)
Equality function specialized for the variable name. If the argument is not a qname, it will deligate to the super class.

Parameters: obj the reference object with which to compare.

Returns: true if this object is the same as the obj argument; false otherwise.

getExpression

public String getExpression()
Get the value expression for this argument.

Returns: String containing the expression previously stored into this argument

See Also: Arg

getQName

public final QName getQName()
Get the qualified name for this argument.

Returns: QName object containing the qualified name

getVal

public final XObject getVal()
Get the value for this argument.

Returns: the argument's stored XObject value.

See Also: setVal

isFromWithParam

public boolean isFromWithParam()
Tell if this variable is a parameter passed with a with-param or as a top-level parameter.

isVisible

public boolean isVisible()
Tell if this variable is currently visible.

setExpression

public void setExpression(String expr)
Set the value expression for this argument.

Parameters: expr String containing the expression to be stored as this argument's value.

See Also: Arg

setIsVisible

public void setIsVisible(boolean b)
Update visibility status of this variable.

setQName

public final void setQName(QName name)
Set the qualified name for this argument.

Parameters: name QName object representing the new Qualified Name.

setVal

public final void setVal(XObject val)
Set the value of this argument.

Parameters: val an XObject representing the arguments's value.

See Also: getVal

Copyright B) 2005 Apache XML Project. All Rights Reserved.