Eclipse Platform
Release 3.1

org.eclipse.text.edits
Class TextEditVisitor

java.lang.Object
  extended byorg.eclipse.text.edits.TextEditVisitor

public class TextEditVisitor
extends Object

A visitor for text edits.

For each different concrete text edit type T there is a method:

In addition, there are methods for visiting text edits in the abstract, regardless of node type:

For edits with children, the child nodes are visited in increasing order.

Since:
3.0
See Also:
TextEdit.accept(TextEditVisitor)

Constructor Summary
TextEditVisitor()
           
 
Method Summary
 void postVisit(TextEdit edit)
          Visits the given text edit following the type-specific visit (after endVisit).
 void preVisit(TextEdit edit)
          Visits the given text edit prior to the type-specific visit.
 boolean visit(CopyingRangeMarker edit)
          Visits a CopyingRangeMarker instance.
 boolean visit(CopySourceEdit edit)
          Visits a CopySourceEdit instance.
 boolean visit(CopyTargetEdit edit)
          Visits a CopyTargetEdit instance.
 boolean visit(DeleteEdit edit)
          Visits a DeleteEdit instance.
 boolean visit(InsertEdit edit)
          Visits a InsertEdit instance.
 boolean visit(MoveSourceEdit edit)
          Visits a MoveSourceEdit instance.
 boolean visit(MoveTargetEdit edit)
          Visits a MoveTargetEdit instance.
 boolean visit(MultiTextEdit edit)
          Visits a MultiTextEdit instance.
 boolean visit(RangeMarker edit)
          Visits a RangeMarker instance.
 boolean visit(ReplaceEdit edit)
          Visits a ReplaceEdit instance.
 boolean visit(UndoEdit edit)
          Visits a UndoEdit instance.
 boolean visitNode(TextEdit edit)
          Visits the given text edit.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextEditVisitor

public TextEditVisitor()
Method Detail

preVisit

public void preVisit(TextEdit edit)
Visits the given text edit prior to the type-specific visit. (before visit).

The default implementation does nothing. Subclasses may reimplement.

Parameters:
edit - the node to visit

postVisit

public void postVisit(TextEdit edit)
Visits the given text edit following the type-specific visit (after endVisit).

The default implementation does nothing. Subclasses may reimplement.

Parameters:
edit - the node to visit

visitNode

public boolean visitNode(TextEdit edit)
Visits the given text edit. This method is called by default from type-specific visits. It is not called by an edit's accept method. The default implementation returns true.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(CopySourceEdit edit)
Visits a CopySourceEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(CopyTargetEdit edit)
Visits a CopyTargetEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(MoveSourceEdit edit)
Visits a MoveSourceEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(MoveTargetEdit edit)
Visits a MoveTargetEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(RangeMarker edit)
Visits a RangeMarker instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(CopyingRangeMarker edit)
Visits a CopyingRangeMarker instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(DeleteEdit edit)
Visits a DeleteEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(InsertEdit edit)
Visits a InsertEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(ReplaceEdit edit)
Visits a ReplaceEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(UndoEdit edit)
Visits a UndoEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

visit

public boolean visit(MultiTextEdit edit)
Visits a MultiTextEdit instance.

Parameters:
edit - the node to visit
Returns:
If true is returned, the given node's child nodes will be visited next; however, if false is returned, the given node's child nodes will not be visited.

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.