org.netbeans.modules.refactoring.java.spi

Class RefactoringVisitor

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

org.netbeans.api.java.source.support.ErrorAwareTreePathScanner<Tree,Element>

org.netbeans.modules.refactoring.java.spi.RefactoringVisitor

All Implemented Interfaces:

com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>, TreeVisitor<Tree,Element>

public class RefactoringVisitor
extends ErrorAwareTreePathScanner<Tree,Element>
implements com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeMaker	make
protected WorkingCopy	workingCopy

Constructor Summary

Constructors

Constructor and Description
RefactoringVisitor()
RefactoringVisitor(boolean javadoc) Creates a new Refactoring Visitor.

Method Summary

Modifier and Type	Method and Description
DocTreePath	getCurrentDocPath() Get the current path for the doctree node, as built up by the currently active set of scan calls.
protected void	rewrite(Tree tree, com.sun.source.doctree.DocTree oldTree, com.sun.source.doctree.DocTree newTree) Replaces the original doctree oldTree with the new one - newTree for a specific tree.
protected void	rewrite(Tree oldTree, Tree newTree)
Tree	scan(Tree tree, Element p)
void	setWorkingCopy(WorkingCopy workingCopy)
com.sun.source.doctree.DocTree	visitAttribute(com.sun.source.doctree.AttributeTree node, Element p)
com.sun.source.doctree.DocTree	visitAuthor(com.sun.source.doctree.AuthorTree node, Element p)
com.sun.source.doctree.DocTree	visitComment(com.sun.source.doctree.CommentTree node, Element p)
com.sun.source.doctree.DocTree	visitDeprecated(com.sun.source.doctree.DeprecatedTree node, Element p)
com.sun.source.doctree.DocTree	visitDocComment(com.sun.source.doctree.DocCommentTree node, Element p)
com.sun.source.doctree.DocTree	visitDocRoot(com.sun.source.doctree.DocRootTree node, Element p)
com.sun.source.doctree.DocTree	visitEndElement(com.sun.source.doctree.EndElementTree node, Element p)
com.sun.source.doctree.DocTree	visitEntity(com.sun.source.doctree.EntityTree node, Element p)
com.sun.source.doctree.DocTree	visitErroneous(com.sun.source.doctree.ErroneousTree node, Element p)
com.sun.source.doctree.DocTree	visitHidden(com.sun.source.doctree.HiddenTree node, Element p)
com.sun.source.doctree.DocTree	visitIdentifier(com.sun.source.doctree.IdentifierTree node, Element p)
com.sun.source.doctree.DocTree	visitIndex(com.sun.source.doctree.IndexTree node, Element p)
com.sun.source.doctree.DocTree	visitInheritDoc(com.sun.source.doctree.InheritDocTree node, Element p)
com.sun.source.doctree.DocTree	visitLink(com.sun.source.doctree.LinkTree node, Element p)
com.sun.source.doctree.DocTree	visitLiteral(com.sun.source.doctree.LiteralTree node, Element p)
com.sun.source.doctree.DocTree	visitOther(com.sun.source.doctree.DocTree node, Element p)
com.sun.source.doctree.DocTree	visitParam(com.sun.source.doctree.ParamTree node, Element p)
com.sun.source.doctree.DocTree	visitProvides(com.sun.source.doctree.ProvidesTree node, Element p)
com.sun.source.doctree.DocTree	visitReference(com.sun.source.doctree.ReferenceTree node, Element p)
com.sun.source.doctree.DocTree	visitReturn(com.sun.source.doctree.ReturnTree node, Element p)
com.sun.source.doctree.DocTree	visitSee(com.sun.source.doctree.SeeTree node, Element p)
com.sun.source.doctree.DocTree	visitSerial(com.sun.source.doctree.SerialTree node, Element p)
com.sun.source.doctree.DocTree	visitSerialData(com.sun.source.doctree.SerialDataTree node, Element p)
com.sun.source.doctree.DocTree	visitSerialField(com.sun.source.doctree.SerialFieldTree node, Element p)
com.sun.source.doctree.DocTree	visitSince(com.sun.source.doctree.SinceTree node, Element p)
com.sun.source.doctree.DocTree	visitStartElement(com.sun.source.doctree.StartElementTree node, Element p)
com.sun.source.doctree.DocTree	visitText(com.sun.source.doctree.TextTree node, Element p)
com.sun.source.doctree.DocTree	visitThrows(com.sun.source.doctree.ThrowsTree node, Element p)
com.sun.source.doctree.DocTree	visitUnknownBlockTag(com.sun.source.doctree.UnknownBlockTagTree node, Element p)
com.sun.source.doctree.DocTree	visitUnknownInlineTag(com.sun.source.doctree.UnknownInlineTagTree node, Element p)
com.sun.source.doctree.DocTree	visitUses(com.sun.source.doctree.UsesTree node, Element p)
com.sun.source.doctree.DocTree	visitValue(com.sun.source.doctree.ValueTree node, Element p)
com.sun.source.doctree.DocTree	visitVersion(com.sun.source.doctree.VersionTree node, Element p)

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

visitCase, visitErroneous

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

getCurrentPath, scan

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

reduce, scan, visitAnnotatedType, visitAnnotation, visitAnyPattern, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBinary, visitBindingPattern, visitBlock, visitBreak, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitConstantCaseLabel, visitContinue, visitDeconstructionPattern, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitExports, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitIntersectionType, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitMemberSelect, visitMethod, visitMethodInvocation, visitModifiers, visitModule, visitNewArray, visitNewClass, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternCaseLabel, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitStringTemplate, visitSwitch, visitSwitchExpression, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnary, visitUnionType, visitUses, visitVariable, visitWhileLoop, visitWildcard, visitYield

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.source.doctree.DocTreeVisitor

visitDocType, visitEscape, visitSnippet, visitSpec, visitSummary, visitSystemProperty

Field Detail

workingCopy

protected WorkingCopy workingCopy

make

protected TreeMaker make

Constructor Detail

RefactoringVisitor

public RefactoringVisitor()

RefactoringVisitor

public RefactoringVisitor(boolean javadoc)

Creates a new Refactoring Visitor.

Parameters:

javadoc - true if javadoc should be visited, false otherwise

Since:

1.47

Method Detail

setWorkingCopy

public void setWorkingCopy(WorkingCopy workingCopy)
                    throws ToPhaseException

Parameters:

workingCopy -

Throws:

ToPhaseException

rewrite

protected void rewrite(Tree oldTree,
                       Tree newTree)

Parameters:

oldTree -

newTree -

rewrite

protected void rewrite(@NonNull
                       Tree tree,
                       @NullAllowed
                       com.sun.source.doctree.DocTree oldTree,
                       @NonNull
                       com.sun.source.doctree.DocTree newTree)

Replaces the original doctree oldTree with the new one - newTree for a specific tree.

To create a new javadoc comment, use rewrite(tree, null, docCommentTree).

tree and newTree cannot be null. If oldTree is null, newTree must be of kind DOC_COMMENT.

Parameters:

tree - the tree to which the doctrees belong.

oldTree - tree to be replaced, use tree already represented in source code. null to create a new file.

newTree - new tree, either created by TreeMaker or obtained from different place. null values are not allowed.

Throws:

IllegalStateException - if toPhase() method was not called before.

Since:

1.47

scan

public Tree scan(Tree tree,
                 Element p)

Overrides:

scan in class TreePathScanner<Tree,Element>

getCurrentDocPath

@CheckForNull
public DocTreePath getCurrentDocPath()

Get the current path for the doctree node, as built up by the currently active set of scan calls.

Returns:

the current DocTreePath, or null of javadoc was disabled

Since:

1.47

See Also:

RefactoringVisitor.RefactoringVisitor(boolean)

visitAttribute

public com.sun.source.doctree.DocTree visitAttribute(com.sun.source.doctree.AttributeTree node,
                                                     Element p)

Specified by:

visitAttribute in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitAuthor

public com.sun.source.doctree.DocTree visitAuthor(com.sun.source.doctree.AuthorTree node,
                                                  Element p)

Specified by:

visitAuthor in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitComment

public com.sun.source.doctree.DocTree visitComment(com.sun.source.doctree.CommentTree node,
                                                   Element p)

Specified by:

visitComment in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitDeprecated

public com.sun.source.doctree.DocTree visitDeprecated(com.sun.source.doctree.DeprecatedTree node,
                                                      Element p)

Specified by:

visitDeprecated in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitDocComment

public com.sun.source.doctree.DocTree visitDocComment(com.sun.source.doctree.DocCommentTree node,
                                                      Element p)

Specified by:

visitDocComment in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitDocRoot

public com.sun.source.doctree.DocTree visitDocRoot(com.sun.source.doctree.DocRootTree node,
                                                   Element p)

Specified by:

visitDocRoot in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitEndElement

public com.sun.source.doctree.DocTree visitEndElement(com.sun.source.doctree.EndElementTree node,
                                                      Element p)

Specified by:

visitEndElement in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitEntity

public com.sun.source.doctree.DocTree visitEntity(com.sun.source.doctree.EntityTree node,
                                                  Element p)

Specified by:

visitEntity in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitErroneous

public com.sun.source.doctree.DocTree visitErroneous(com.sun.source.doctree.ErroneousTree node,
                                                     Element p)

Specified by:

visitErroneous in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitHidden

public com.sun.source.doctree.DocTree visitHidden(com.sun.source.doctree.HiddenTree node,
                                                  Element p)

Specified by:

visitHidden in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

visitIdentifier

public com.sun.source.doctree.DocTree visitIdentifier(com.sun.source.doctree.IdentifierTree node,
                                                      Element p)

Specified by:

visitIdentifier in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitIndex

public com.sun.source.doctree.DocTree visitIndex(com.sun.source.doctree.IndexTree node,
                                                 Element p)

Specified by:

visitIndex in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

visitInheritDoc

public com.sun.source.doctree.DocTree visitInheritDoc(com.sun.source.doctree.InheritDocTree node,
                                                      Element p)

Specified by:

visitInheritDoc in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitLink

public com.sun.source.doctree.DocTree visitLink(com.sun.source.doctree.LinkTree node,
                                                Element p)

Specified by:

visitLink in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitLiteral

public com.sun.source.doctree.DocTree visitLiteral(com.sun.source.doctree.LiteralTree node,
                                                   Element p)

Specified by:

visitLiteral in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitParam

public com.sun.source.doctree.DocTree visitParam(com.sun.source.doctree.ParamTree node,
                                                 Element p)

Specified by:

visitParam in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitProvides

public com.sun.source.doctree.DocTree visitProvides(com.sun.source.doctree.ProvidesTree node,
                                                    Element p)

Specified by:

visitProvides in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.62

visitReference

public com.sun.source.doctree.DocTree visitReference(com.sun.source.doctree.ReferenceTree node,
                                                     Element p)

Specified by:

visitReference in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitReturn

public com.sun.source.doctree.DocTree visitReturn(com.sun.source.doctree.ReturnTree node,
                                                  Element p)

Specified by:

visitReturn in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitSee

public com.sun.source.doctree.DocTree visitSee(com.sun.source.doctree.SeeTree node,
                                               Element p)

Specified by:

visitSee in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitSerial

public com.sun.source.doctree.DocTree visitSerial(com.sun.source.doctree.SerialTree node,
                                                  Element p)

Specified by:

visitSerial in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitSerialData

public com.sun.source.doctree.DocTree visitSerialData(com.sun.source.doctree.SerialDataTree node,
                                                      Element p)

Specified by:

visitSerialData in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitSerialField

public com.sun.source.doctree.DocTree visitSerialField(com.sun.source.doctree.SerialFieldTree node,
                                                       Element p)

Specified by:

visitSerialField in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitSince

public com.sun.source.doctree.DocTree visitSince(com.sun.source.doctree.SinceTree node,
                                                 Element p)

Specified by:

visitSince in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitStartElement

public com.sun.source.doctree.DocTree visitStartElement(com.sun.source.doctree.StartElementTree node,
                                                        Element p)

Specified by:

visitStartElement in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitText

public com.sun.source.doctree.DocTree visitText(com.sun.source.doctree.TextTree node,
                                                Element p)

Specified by:

visitText in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitThrows

public com.sun.source.doctree.DocTree visitThrows(com.sun.source.doctree.ThrowsTree node,
                                                  Element p)

Specified by:

visitThrows in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitUnknownBlockTag

public com.sun.source.doctree.DocTree visitUnknownBlockTag(com.sun.source.doctree.UnknownBlockTagTree node,
                                                           Element p)

Specified by:

visitUnknownBlockTag in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitUnknownInlineTag

public com.sun.source.doctree.DocTree visitUnknownInlineTag(com.sun.source.doctree.UnknownInlineTagTree node,
                                                            Element p)

Specified by:

visitUnknownInlineTag in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitUses

public com.sun.source.doctree.DocTree visitUses(com.sun.source.doctree.UsesTree node,
                                                Element p)

Specified by:

visitUses in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.62

visitValue

public com.sun.source.doctree.DocTree visitValue(com.sun.source.doctree.ValueTree node,
                                                 Element p)

Specified by:

visitValue in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitVersion

public com.sun.source.doctree.DocTree visitVersion(com.sun.source.doctree.VersionTree node,
                                                   Element p)

Specified by:

visitVersion in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47

visitOther

public com.sun.source.doctree.DocTree visitOther(com.sun.source.doctree.DocTree node,
                                                 Element p)

Specified by:

visitOther in interface com.sun.source.doctree.DocTreeVisitor<com.sun.source.doctree.DocTree,Element>

Since:

1.47