Package org.eclipse.ltk.core.refactoring
Class DocumentChange
java.lang.Object
org.eclipse.ltk.core.refactoring.Change
org.eclipse.ltk.core.refactoring.TextEditBasedChange
org.eclipse.ltk.core.refactoring.TextChange
org.eclipse.ltk.core.refactoring.DocumentChange
- All Implemented Interfaces:
IAdaptable
A text change that operates directly on instances of
IDocument.
The document change uses a simple length compare to check if it
is still valid. So as long as its length hasn't changed the text edits
managed have a valid range and can be applied to the document. The
same applies to the undo change returned from the perform method.
Note: this class is not intended to be extended by clients.
- Since:
- 3.0
- Restriction:
- This class is not intended to be subclassed by clients.
-
Constructor Summary
ConstructorsConstructorDescriptionDocumentChange(String name, IDocument document) Creates a newDocumentChangefor the givenIDocument. -
Method Summary
Modifier and TypeMethodDescriptionprotected IDocumentAcquires a reference to the document to be changed by this text change.protected voidcommit(IDocument document, IProgressMonitor pm) Commits the document acquired via a call toaquireDocument.protected ChangecreateUndoChange(UndoEdit edit) Hook to create an undo change for the given undo edit.Returns the element modified by thisChange.voidHook method to initialize some internal state to provide an adequate answer for theisValidmethod.Verifies that this change object is still valid and can be executed by callingperform.protected UndoEditperformEdits(IDocument document) Executes the text edits on the given document.protected voidreleaseDocument(IDocument document, IProgressMonitor pm) Releases the document acquired via a call toaquireDocument.Methods inherited from class org.eclipse.ltk.core.refactoring.TextChange
addEdit, addTextEditChangeGroup, addTextEditGroup, getCurrentContent, getCurrentContent, getCurrentDocument, getEdit, getPreviewContent, getPreviewContent, getPreviewContent, getPreviewDocument, getPreviewEdit, getPreviewEdits, getTextEditChangeGroups, perform, setEdit, setKeepPreviewEditsMethods inherited from class org.eclipse.ltk.core.refactoring.TextEditBasedChange
addChangeGroup, getChangeGroups, getKeepPreviewEdits, getName, getTextType, hasOneGroupCategory, setEnabled, setTextTypeMethods inherited from class org.eclipse.ltk.core.refactoring.Change
dispose, getAdapter, getAffectedObjects, getDescriptor, getParent, isEnabled, setEnabledShallow
-
Constructor Details
-
DocumentChange
Creates a newDocumentChangefor the givenIDocument.- Parameters:
name- the change's name. Has to be a human readable name.document- the document this change is working on
-
-
Method Details
-
getModifiedElement
Description copied from class:ChangeReturns the element modified by thisChange. The method may returnnullif the change isn't related to an element.- Specified by:
getModifiedElementin classChange- Returns:
- the element modified by this change
-
initializeValidationData
Description copied from class:ChangeHook method to initialize some internal state to provide an adequate answer for theisValidmethod. This method gets called after a change or a whole change tree has been created.Typically this method is implemented in one of the following ways:
- the change hooks up a listener on some delta notification mechanism
and marks itself as invalid if it receives a certain delta. Is this
the case the implementor must take care of unhooking the listener
in
dispose. - the change remembers some information allowing to decide if a change
object is still valid when
isValidis called.
For example, a change object that manipulates the content of an
IFilecould either listen to resource changes and detect that the file got changed or it could remember some content stamp and compare it with the actual content stamp whenisValidis called.- Specified by:
initializeValidationDatain classChange- Parameters:
pm- a progress monitor
- the change hooks up a listener on some delta notification mechanism
and marks itself as invalid if it receives a certain delta. Is this
the case the implementor must take care of unhooking the listener
in
-
isValid
Description copied from class:ChangeVerifies that this change object is still valid and can be executed by callingperform. If a refactoring status with a severity ofRefactoringStatus.FATALis returned then the change has to be treated as invalid and can no longer be executed. Performing such a change produces an unspecified result and will very likely throw an exception.This method is also called by the
UndoManagerto decide if an undo or redo change is still valid and therefore can be executed.- Specified by:
isValidin classChange- Parameters:
pm- a progress monitor.- Returns:
- a refactoring status describing the outcome of the validation check
- Throws:
CoreException- if an error occurred during validation check. The change is to be treated as invalid if an exception occurs
-
acquireDocument
Description copied from class:TextChangeAcquires a reference to the document to be changed by this text change. A document acquired by this call MUST be released via a call toTextChange.releaseDocument(IDocument, IProgressMonitor).The method
releaseDocumentmust be called as many times asaquireDocumenthas been called.- Specified by:
acquireDocumentin classTextChange- Parameters:
pm- a progress monitor- Returns:
- a reference to the document to be changed
- Throws:
CoreException- if the document can't be acquired
-
commit
Description copied from class:TextChangeCommits the document acquired via a call toaquireDocument. It is up to the implementors of this method to decide what committing a document means. Typically, the content of the document is written back to the file system.- Specified by:
commitin classTextChange- Parameters:
document- the document to commitpm- a progress monitor- Throws:
CoreException- if the document can't be committed
-
releaseDocument
Description copied from class:TextChangeReleases the document acquired via a call toaquireDocument.- Specified by:
releaseDocumentin classTextChange- Parameters:
document- the document to releasepm- a progress monitor- Throws:
CoreException- if the document can't be released
-
performEdits
protected UndoEdit performEdits(IDocument document) throws BadLocationException, MalformedTreeException Description copied from class:TextChangeExecutes the text edits on the given document. Subclasses that override this method should callsuper.performEdits(document).- Overrides:
performEditsin classTextChange- Parameters:
document- the document- Returns:
- an object representing the undo of the executed edits
- Throws:
BadLocationException- is thrown if one of the edits in the tree can't be executed. The state of the document is undefined if this exception is thrown.MalformedTreeException- is thrown if the edit tree isn't in a valid state. This exception is thrown before any edit is executed. So the document is still in its original state.
-
createUndoChange
Description copied from class:TextChangeHook to create an undo change for the given undo edit. This hook gets called while performing the change to construct the corresponding undo change object.- Specified by:
createUndoChangein classTextChange- Parameters:
edit- theUndoEditto create an undo change for- Returns:
- the undo change or
nullif no undo change can be created. Returningnullresults in the fact that the whole change tree can't be undone. So returningnullis only recommended if an exception occurred during the creation of the undo change.
-