net.sf.saxon.expr

Class ComponentBinding

java.lang.Object

net.sf.saxon.expr.ComponentBinding

public class ComponentBinding
extends Object

A ComponentBinding is a reference from one component to another; for example a variable reference or function call. ComponentBindings are held in the binding vector of the calling component, and are separate from the instruction/expression that contains the reference, to provide a level of indirection; this means that when a component is re-bound in a using package, for example to call overriding versions of templates or functions called from the component, the compiled code of the calling component does not need to be changed, only the contents of the binding vector.

Constructor Summary

Constructors

Constructor and Description
ComponentBinding(SymbolicName name) Create a ComponentBinding

Method Summary

Methods

Modifier and Type	Method and Description
SymbolicName	getSymbolicName() Get the symbolic name of the component binding
Component	getTarget() Get the target of the component binding, for example a template, function, or global variable.
boolean	isFinal() Ask whether this binding is final
void	setTarget(Component target, boolean isFinal) Set the target of the component binding, for example a template, function, or global variable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentBinding

public ComponentBinding(SymbolicName name)

Create a ComponentBinding

Parameters:

name - the symbolic name of the component that is the target of this binding. This includes the component kind (e.g. function, template, variable), its name, and in the case of functions, its arity.

Method Detail

getSymbolicName

public SymbolicName getSymbolicName()

Get the symbolic name of the component binding

Returns:

the symbolic name of the component that is the target of this binding. This includes the component kind (e.g. function, template, variable), its name, and in the case of functions, its arity.

setTarget

public void setTarget(Component target,
             boolean isFinal)

Set the target of the component binding, for example a template, function, or global variable

Parameters:

target - the target of the binding

isFinal - true if this is a final binding that cannot be changed in a using package. This will be the case if the visibility of the target component is private or final.

getTarget

public Component getTarget()

Get the target of the component binding, for example a template, function, or global variable.

Returns:

the target of the component binding

isFinal

public boolean isFinal()

Ask whether this binding is final

Returns:

true if the binding is final. This will be the case if the visibility of the target component is private, hidden, or final.