OpenJDK 27 · com.sun.org.apache.xpath.internal.operations.Variable

Modifier and Type	Field and Description
private boolean	m_fixUpWasCalled Tell if fixupVariables was called.
protected int	m_index The index of the variable, which is either an absolute index to a global, or, if higher than the globals area, must be adjusted by adding the offset to the current stack frame.
protected boolean	m_isGlobal
protected QName	m_qname The qualified name of the variable.
pack-priv static final String	PSUEDOVARNAMESPACE
pack-priv static final long	serialVersionUID Hides com.sun.org.apache.xpath.internal.Expression.serialVersionUID.

Access	Constructor and Description
public	Variable()

Method Summary

Modifier and Type	Method and Description
public void	callVisitors(ExpressionOwner owner, XPathVisitor visitor) Implements com.sun.org.apache.xpath.internal.XPathVisitable.callVisitors. This will traverse the heararchy, calling the visitor for each member.
public boolean	deepEquals(Expression expr) Implements abstract com.sun.org.apache.xpath.internal.Expression.deepEquals. Compare this object with another object and see if they are equal, include the sub heararchy.
public XObject	Returns: The result of the expression in the form of a `XObject`. execute(XPathContext The XPath runtime context. xctxt) Implements abstract com.sun.org.apache.xpath.internal.Expression.execute. Execute an expression in the XPath runtime context, and return the result of the expression.
public XObject	Returns: The evaluated variable, or an empty nodeset if not found. execute(XPathContext The runtime execution context. xctxt, boolean destructiveOK) Overrides com.sun.org.apache.xpath.internal.Expression.execute. Dereference the variable, and return the reference value.
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) Implements abstract com.sun.org.apache.xpath.internal.Expression.fixupVariables. This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
public int	Returns: One of WalkerFactory#BIT_DESCENDANT, etc. getAnalysisBits() Implements com.sun.org.apache.xpath.internal.axes.PathComponent.getAnalysisBits. Get the analysis bits for this walker, as defined in the WalkerFactory.
public boolean	Returns: true if this should be a global variable reference. getGlobal() Set the index for the variable into the stack.
public int	Returns: index a global or local index. getIndex() Set the index for the variable into the stack.
public QName	Returns: A non-null reference to a qualified name. getQName() Get the qualified name of the variable.
public boolean	isPsuedoVarRef() Tell if this is a psuedo variable reference, declared by Xalan instead of by the user.
public boolean	Returns: true if the expression represents a stable number. isStableNumber() Overrides com.sun.org.apache.xpath.internal.Expression.isStableNumber. Tell if this expression returns a stable number that will not change during iterations within the expression.
public void	setIndex(int a global or local index. index) Set the index for the variable into the stack.
public void	setIsGlobal(boolean true if this should be a global variable reference. isGlobal) Set whether or not this is a global reference.
public void	setQName(QName Must be a non-null reference to a qualified name. qname) Set the qualified name of the variable.

m_fixUpWasCalled	back to summary
private boolean m_fixUpWasCalled Tell if fixupVariables was called.

m_index	back to summary
protected int m_index The index of the variable, which is either an absolute index to a global, or, if higher than the globals area, must be adjusted by adding the offset to the current stack frame.

m_isGlobal	back to summary
protected boolean m_isGlobal

m_qname	back to summary
protected QName m_qname The qualified name of the variable.

PSUEDOVARNAMESPACE	back to summary
pack-priv static final String PSUEDOVARNAMESPACE

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides com.sun.org.apache.xpath.internal.Expression.serialVersionUID.

Variable	back to summary
public Variable()

Method Detail

callVisitors back to summary

callVisitors	back to summary
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor) Implements com.sun.org.apache.xpath.internal.XPathVisitable.callVisitors. Doc from com.sun.org.apache.xpath.internal.XPathVisitable.callVisitors. This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called. See Also `com.sun.org.apache.xpath.internal.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)`

public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)

Implements com.sun.org.apache.xpath.internal.XPathVisitable.callVisitors.

Doc from com.sun.org.apache.xpath.internal.XPathVisitable.callVisitors.

This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called.

See Also: com.sun.org.apache.xpath.internal.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)

deepEquals back to summary

deepEquals	back to summary
public boolean deepEquals(Expression expr) Implements abstract com.sun.org.apache.xpath.internal.Expression.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. See Also `Expression#deepEquals(Expression)`

public boolean deepEquals(Expression expr)

Implements abstract com.sun.org.apache.xpath.internal.Expression.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.

See Also: Expression#deepEquals(Expression)

execute back to summary

execute	back to summary
public XObject execute(XPathContext xctxt) throws TransformerException Implements abstract com.sun.org.apache.xpath.internal.Expression.execute. Execute an expression in the XPath runtime context, and return the result of the expression. Parameters xctxt:XPathContext The XPath runtime context. Returns:XObject The result of the expression in the form of a `XObject`. Exceptions TransformerException: if a runtime exception occurs.

public XObject execute(XPathContext xctxt) throws TransformerException

Implements abstract com.sun.org.apache.xpath.internal.Expression.execute.

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

Parameters

xctxt:XPathContext: The XPath runtime context.

Returns:XObject

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

Exceptions

TransformerException:: if a runtime exception occurs.

execute	back to summary
public XObject execute(XPathContext xctxt, boolean destructiveOK) throws TransformerException Overrides com.sun.org.apache.xpath.internal.Expression.execute. Dereference the variable, and return the reference value. Note that lazy evaluation will occur. If a variable within scope is not found, a warning will be sent to the error listener, and an empty nodeset will be returned. Parameters xctxt:XPathContext The runtime execution context. Returns:XObject The evaluated variable, or an empty nodeset if not found. Exceptions TransformerException: Doc from com.sun.org.apache.xpath.internal.Expression.execute. if a runtime exception occurs.

execute

back to summary

public XObject execute(XPathContext xctxt, boolean destructiveOK) throws TransformerException

Overrides com.sun.org.apache.xpath.internal.Expression.execute.

Dereference the variable, and return the reference value. Note that lazy evaluation will occur. If a variable within scope is not found, a warning will be sent to the error listener, and an empty nodeset will be returned.

Parameters

xctxt:XPathContext: The runtime execution context.

Returns:XObject

The evaluated variable, or an empty nodeset if not found.

Exceptions

TransformerException:

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

if a runtime exception occurs.

fixupVariables	back to summary
public void fixupVariables(List<QName> vars, int globalsSize) Implements abstract com.sun.org.apache.xpath.internal.Expression.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).

fixupVariables

back to summary

public void fixupVariables(List<QName> vars, int globalsSize)

Implements abstract com.sun.org.apache.xpath.internal.Expression.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).

getAnalysisBits	back to summary
public int getAnalysisBits() Implements com.sun.org.apache.xpath.internal.axes.PathComponent.getAnalysisBits. Get the analysis bits for this walker, as defined in the WalkerFactory. Returns:int One of WalkerFactory#BIT_DESCENDANT, etc.

getAnalysisBits

back to summary

public int getAnalysisBits()

Implements com.sun.org.apache.xpath.internal.axes.PathComponent.getAnalysisBits.

Get the analysis bits for this walker, as defined in the WalkerFactory.

Returns:int: One of WalkerFactory#BIT_DESCENDANT, etc.

getGlobal	back to summary
public boolean getGlobal() Set the index for the variable into the stack. For advanced use only. Returns:boolean true if this should be a global variable reference.

getGlobal

back to summary

public boolean getGlobal()

Set the index for the variable into the stack. For advanced use only.

Returns:boolean: true if this should be a global variable reference.

getIndex	back to summary
public int getIndex() Set the index for the variable into the stack. For advanced use only. Returns:int index a global or local index.

getIndex

back to summary

public int getIndex()

Set the index for the variable into the stack. For advanced use only.

Returns:int: index a global or local index.

getQName	back to summary
public QName getQName() Get the qualified name of the variable. Returns:QName A non-null reference to a qualified name.

getQName

back to summary

public QName getQName()

Get the qualified name of the variable.

Returns:QName: A non-null reference to a qualified name.

isPsuedoVarRef	back to summary
public boolean isPsuedoVarRef() Tell if this is a psuedo variable reference, declared by Xalan instead of by the user.

isStableNumber	back to summary
public boolean isStableNumber() Overrides com.sun.org.apache.xpath.internal.Expression.isStableNumber. Tell if this expression returns a stable number that will not change during iterations within the expression. This is used to determine if a proximity position predicate can indicate that no more searching has to occur. Returns:boolean true if the expression represents a stable number.

isStableNumber

back to summary

public boolean isStableNumber()

Overrides com.sun.org.apache.xpath.internal.Expression.isStableNumber.

Tell if this expression returns a stable number that will not change during iterations within the expression. This is used to determine if a proximity position predicate can indicate that no more searching has to occur.

Returns:boolean: true if the expression represents a stable number.

setIndex	back to summary
public void setIndex(int index) Set the index for the variable into the stack. For advanced use only. You must know what you are doing to use this. Parameters index:int a global or local index.

setIndex

back to summary

public void setIndex(int index)

Set the index for the variable into the stack. For advanced use only. You must know what you are doing to use this.

Parameters

index:int: a global or local index.

setIsGlobal	back to summary
public void setIsGlobal(boolean isGlobal) Set whether or not this is a global reference. For advanced use only. Parameters isGlobal:boolean true if this should be a global variable reference.

setIsGlobal

back to summary

public void setIsGlobal(boolean isGlobal)

Set whether or not this is a global reference. For advanced use only.

Parameters

isGlobal:boolean: true if this should be a global variable reference.

setQName	back to summary
public void setQName(QName qname) Set the qualified name of the variable. Parameters qname:QName Must be a non-null reference to a qualified name.

setQName

back to summary

public void setQName(QName qname)

Set the qualified name of the variable.

Parameters

qname:QName: Must be a non-null reference to a qualified name.

public Class Variable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail