Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.text.edits
Interface ISourceModifier

public interface ISourceModifier

A source modifier can be used to modify the source of a move or copy edit before it gets inserted at the target position. This is useful if the text to be copied has to be modified before it is inserted without changing the original source.

Since:

3.0

Method Summary

ISourceModifier	copy() Creates a copy of this source modifier object.
ReplaceEdit[]	getModifications(String source) Returns the modification to be done to the passed string in form of replace edits.

Method Detail

getModifications

public ReplaceEdit[] getModifications(String source)

Returns the modification to be done to the passed string in form of replace edits. The set of returned replace edits must modify disjoint text regions. Violating this requirement will result in a BadLocationException while executing the associated move or copy edit.

The caller of this method is responsible to apply the returned edits to the passed source.

Parameters:

source - the source to be copied or moved

Returns:

an array of ReplaceEdits describing the modifications.

copy

public ISourceModifier copy()

Creates a copy of this source modifier object. The copy will be used in a different text edit object. So it should be created in a way that is doesn't conflict with other text edits refering to this source modifier.

Returns:

the copy of the source modifier