org.netbeans.api.java.source

Class DocTreePathHandle

java.lang.Object

org.netbeans.api.java.source.DocTreePathHandle

public final class DocTreePathHandle
extends Object

Represents a handle for TreePath which can be kept and later resolved by another javac. The Javac Elements are valid only in the single CompilationTask or single run of the CancellableTask. If the client needs to keep a reference to the TreePath and use it in the other CancellableTask he has to serialize it into the TreePathHandle.

Typical usage of TreePathHandle enclElIsCorrespondingEl:

 final TreePathHandle[] tpHandle = new TreePathHandle[1];
 javaSource.runCompileControlTask(new CancellableTask() {
     public void run(CompilationController compilationController) {
         parameter.toPhase(Phase.RESOLVED);
         CompilationUnitTree cu = compilationController.getTree ();
         TreePath treePath = getInterestingTreePath (cu);
         treePathHandle[0] = TreePathHandle.create (element, compilationController);
    }
 },priority);

 otherJavaSource.runCompileControlTask(new CancellableTask() {
     public void run(CompilationController compilationController) {
         parameter.toPhase(Phase.RESOLVED);
         TreePath treePath = treePathHanlde[0].resolve (compilationController);
         ....
    }
 },priority);
 

Since:

0.124

Method Summary

Modifier and Type	Method and Description
static DocTreePathHandle	create(DocTreePath docTreePath, CompilationInfo javac) Factory method for creating DocTreePathHandle.
boolean	equals(Object obj)
com.sun.source.doctree.DocTree.Kind	getKind() Returns the DocTree.Kind of this DocTreePathHandle, it returns the kind of the DocTree from which the handle was created.
TreePathHandle	getTreePathHandle() returns TreePathHandle corresponding to this DocTreePathHandle
int	hashCode()
DocTreePath	resolve(CompilationInfo compilationInfo) Resolves an DocTreePath from the DocTreePathHandle.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

resolve

public DocTreePath resolve(CompilationInfo compilationInfo)
                    throws IllegalArgumentException

Resolves an DocTreePath from the DocTreePathHandle.

Parameters:

compilationInfo - representing the CompilationTask

Returns:

resolved subclass of DocTreePath or null if the doctree does not exist on the classpath/sourcepath of CompilationTask.

Throws:

IllegalArgumentException - when this DocTreePathHandle is not created for a source represented by the compilationInfo.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTreePathHandle

public TreePathHandle getTreePathHandle()

returns TreePathHandle corresponding to this DocTreePathHandle

Returns:

TreePathHandle

getKind

public com.sun.source.doctree.DocTree.Kind getKind()

Returns the DocTree.Kind of this DocTreePathHandle, it returns the kind of the DocTree from which the handle was created.

Returns:

Tree.Kind

create

public static DocTreePathHandle create(DocTreePath docTreePath,
                                       CompilationInfo javac)
                                throws IllegalArgumentException

Factory method for creating DocTreePathHandle.

Parameters:

docTreePath - for which the DocTreePathHandle should be created.

javac -

Returns:

a new DocTreePathHandle

Throws:

IllegalArgumentException - if arguments are not supported

toString

public String toString()

Overrides:

toString in class Object