jackpot: TreePathQuery (Jackpot)

HOME > Community > Projects > jackpot

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.jackpot/2 2 1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.jackpot
Class TreePathQuery<R,P>

java.lang.Object
  com.sun.source.util.TreeScanner<R,P>
      com.sun.source.util.TreePathScanner<R,P>
          org.netbeans.api.java.source.support.CancellableTreePathScanner<R,P>
              org.netbeans.api.jackpot.TreePathQuery<R,P>

All Implemented Interfaces:: TreeVisitor<R,P>, Query

Direct Known Subclasses:: TreePathTransformer

public abstract class TreePathQuery<R,P>
extends org.netbeans.api.java.source.support.CancellableTreePathScanner<R,P>
implements Query
extends org.netbeans.api.java.source.support.CancellableTreePathScanner<R,P>
implements Query

An abstract Query which extends TreePathScanner to visit the project's AST nodes using the visitor pattern.

See Also:: TreePath, TreePathScanner, CancellableTreePathScanner

Constructor Summary

TreePathQuery()


Method Summary

void addResult()
          Adds a result using the scanner's current TreePath, without any comment.

void addResult(String note)
          Adds a result using the scanner's current TreePath.

void addResult(TreePath path, String note)
          Forward a result (query match) to the query's context.

void attach(org.netbeans.api.java.source.CompilationInfo info)
          Attach this Query instance to the specified CompilationInfo prior to processing one or more source files.

void destroy()
          Release any instance data shared by invocations, including all references to the JavaSource instanced passed to init().

org.netbeans.api.java.source.CompilationInfo getCompilationInfo()
          Returns the CompilationInfo attached to this query.

QueryContext getContext()
          Returns the context the query is executing within.

org.netbeans.api.java.source.JavaSource getJavaSource()
          Returns the JavaSource this query was initialized with.

void init(QueryContext context, org.netbeans.api.java.source.JavaSource source)
          Initialize any data that is shared across source file processing invocations.

void release()
          Release any instance data created by attach() or the processing of a set of source files.

void run()
          Execute the query for the set of source files.

Methods inherited from class org.netbeans.api.java.source.support.CancellableTreePathScanner

cancel, isCanceled, scan, scan

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, visitAnnotation, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBinary, visitBlock, visitBreak, visitCase, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitLabeledStatement, visitLiteral, visitMemberSelect, visitMethod, visitMethodInvocation, visitModifiers, visitNewArray, visitNewClass, visitOther, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitReturn, visitSwitch, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnary, visitVariable, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.api.jackpot.Query

cancel

Constructor Detail

TreePathQuery

public TreePathQuery()

Method Detail