org.eclipse.text.edits
Class MultiTextEdit

java.lang.Object
  

org.eclipse.text.edits.TextEdit
      
org.eclipse.text.edits.MultiTextEdit

Direct Known Subclasses:

MultiTextEditWithProgress

public class MultiTextEdit
extends 
TextEdit

A multi-text edit can be used to aggregate several edits into one edit. The edit itself doesn't modify a document.

Clients are allowed to implement subclasses of a multi-text edit.Subclasses must implement doCopy() to ensure the a copy of the right type is created. Not implementing doCopy() in subclasses will result in an assertion failure during copying.

Since:

3.0

Field Summary

 

Fields inherited from class org.eclipse.text.edits. TextEdit
CREATE_UNDO, NONE, UPDATE_REGIONS

 

Constructor Summary
	MultiTextEdit ()           Creates a new MultiTextEdit.
	MultiTextEdit (int offset, int length)           Creates a new MultiTextEdit for the given range.
protected	MultiTextEdit ( MultiTextEdit other)

 

Method Summary
protected  void	accept0 ( TextEditVisitor visitor)           Accepts the given visitor on a type-specific visit of the current edit.
protected  boolean	canZeroLengthCover ()           Returns true if an edit with length zero can cover another edit.
protected  void	checkIntegrity ()           Checks the edit's integrity.
boolean	covers ( TextEdit other)           Returns true if the edit covers the given edit other.
protected   TextEdit	doCopy ()           Creates and returns a copy of this edit.
int	getLength ()           Returns the length of the edit.
int	getOffset ()           Returns the offset of the edit.

 

Methods inherited from class org.eclipse.text.edits. TextEdit
accept, acceptChildren, addChild, addChildren, apply, apply, childDocumentUpdated, childRegionUpdated, copy, equals, getChildren, getChildrenSize, getCoverage, getExclusiveEnd, getInclusiveEnd, getParent, getRegion, getRoot, hasChildren, hashCode, isDeleted, moveTree, postProcessCopy, removeChild, removeChild, removeChildren, toString

 

Methods inherited from class java.lang. Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Constructor Detail

MultiTextEdit

public MultiTextEdit()

Creates a new MultiTextEdit. The range of the edit is determined by the range of its children. Adding this edit to a parent edit sets its range to the range covered by its children. If the edit doesn't have any children its offset is set to the parent's offset and its length is set to 0.

MultiTextEdit

public MultiTextEdit(int offset,
                     int length)

Creates a new MultiTextEdit for the given range. Adding a child to this edit which isn't covered by the given range will result in an exception.

Parameters:

offset - the edit's offset

length - the edit's length.

See Also:

TextEdit.addChild(TextEdit), TextEdit.addChildren(TextEdit[])

MultiTextEdit

protected MultiTextEdit(
MultiTextEdit other)

checkIntegrity

protected void checkIntegrity()
                       throws 
MalformedTreeException

Checks the edit's integrity.

Note that this method should only be called by the edit framework and not by normal clients.

This default implementation does nothing. Subclasses may override if needed.

Throws:

MalformedTreeException - if the edit isn't in a valid state and can therefore not be executed

getOffset

public final int getOffset()

Returns the offset of the edit. An offset is a 0-based character index. Returns -1 if the edit is marked as deleted.

Overrides:

getOffset in class TextEdit

Returns:

the offset of the edit

getLength

public final int getLength()

Returns the length of the edit. Returns -1 if the edit is marked as deleted.

Overrides:

getLength in class TextEdit

Returns:

the length of the edit

covers

public final boolean covers(
TextEdit other)

Returns true if the edit covers the given edit other. It is up to the concrete text edit to decide if a edit of length zero can cover another edit.

Overrides:

covers in class TextEdit

Parameters:

other - the other edit

Returns:

true if the edit covers the other edit; otherwise false is returned.

protected boolean canZeroLengthCover()

protected 
TextEdit doCopy()

protected void accept0(
TextEditVisitor visitor)