org.apache.flex.compiler.common

Class NodeReference

java.lang.Object

org.apache.flex.compiler.common.NodeReference

public class NodeReference
extends Object

Helper class to abstract the details of how we get back to Nodes from Definitions and NamespaceReferences. This class holds a WeakRef to the IASNode, and is able to regenerate the IASNode if needed after it has been collected.

Field Summary

Fields

Modifier and Type	Field and Description
static NodeReference	noReference static that represents no NodeReference (e.g. for defs that came from an ABC)

Constructor Summary

Constructors

Constructor and Description
NodeReference(IASNode node) Construct a NodeReference to the given node
NodeReference(IFileSpecification containingFileSpec, int absoluteStart) Construct a NodeReference to a node in the specified file at the specified offset.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAbsoluteStart() Get the start offset for the node
IFileSpecification	getFileSpecification() Get the file spec for this Node
IASNode	getNode(IWorkspace workspace, ASScope scope) Get a strong reference to the Node.
IASNode	getNodeIfExists() Get the node from the underlying weak reference.
void	reconnectNode(IASNode node) Explicitly re-connect this node reference to the specified node.

Methods inherited from class java.lang.Object

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

Field Detail

noReference

public static NodeReference noReference

static that represents no NodeReference (e.g. for defs that came from an ABC)

Constructor Detail

NodeReference

public NodeReference(IASNode node)

Construct a NodeReference to the given node

Parameters:

node - the node to references

NodeReference

public NodeReference(IFileSpecification containingFileSpec,
             int absoluteStart)

Construct a NodeReference to a node in the specified file at the specified offset. This constructor is used from the MXMLScopeBuilder, where we only have temporary tree nodes.

Parameters:

containingFileSpec - File that contains the node this reference refers to.

absoluteStart - The offset at which the node this reference refers to starts.

Method Detail

getFileSpecification

public IFileSpecification getFileSpecification()

Get the file spec for this Node

getAbsoluteStart

public int getAbsoluteStart()

Get the start offset for the node

getNode

public IASNode getNode(IWorkspace workspace,
              ASScope scope)

Get a strong reference to the Node. If necessary this will reparse the file to find the correct Node. This method may return null, such as when document is so malformed that we can't produce a file node for it. (Note that MXMLScopeBuilder can produce definitions with NodeReferences into a malformed document.)

Parameters:

workspace - the Workspace to use to parse the file

scope - the containing scope of the definition we want the node for - this is used to find the ASFileScope it's contained in to reconnect the definitions and Nodes if the file needs to be reparsed

getNodeIfExists

public IASNode getNodeIfExists()

Get the node from the underlying weak reference. This will not do any parsing or any other work to recover the Node if it has been collected

Returns:

the IASNode this reference refers to, or null if the Node no longer exists

reconnectNode

public void reconnectNode(IASNode node)

Explicitly re-connect this node reference to the specified node.

Parameters:

node - The IASNode to re-connect this node reference to.