org.eclipse.xtext.formatting2.regionaccess

Interface ITextRegionDiffBuilder

All Known Implementing Classes:

StringBasedTextRegionAccessDiffBuilder

public interface ITextRegionDiffBuilder

Create instances of ITextRegionAccessDiff. The purpose of this service is to create a modified copy of a ITextRegionAccess. This service guarantees that

1. the result has a valid strictly alternating sequence of IHiddenRegions and ISemanticRegions.
2. IComments are appropriately handled according to how associated ISemanticRegion are modified. See IHiddenRegionPartAssociator to customize this behavior.
3. The order in which methods of this service are called does not impact the result, except for insertions.

This service does NOT guarantee consistency to the grammar. This is the callers responsibility.

Since:

2.13

Noextend:

This interface is not intended to be extended by clients.

Noimplement:

This interface is not intended to be implemented by clients.

Method Summary

Modifier and Type	Method and Description
ITextRegionAccessDiff	create()
ITextRegionAccess	getOriginalTextRegionAccess()
boolean	isModified(org.eclipse.xtext.util.ITextRegion region)
void	move(IHiddenRegion insertAt, IHiddenRegion substituteFirst, IHiddenRegion substituteLast)
void	remove(IHiddenRegion first, IHiddenRegion last)
void	remove(ISemanticRegion region)
void	replace(IHiddenRegion first, IHiddenRegion last, IHiddenRegion substituteFirst, IHiddenRegion substituteLast)
void	replace(IHiddenRegion first, IHiddenRegion last, ITextRegionAccess substitute)
void	replace(ISemanticRegion region, java.lang.String newText)
ISequenceAcceptor	replaceSequence(IHiddenRegion first, IHiddenRegion last, ISerializationContext ctx, org.eclipse.emf.ecore.EObject root)

Method Detail

create

ITextRegionAccessDiff create()

getOriginalTextRegionAccess

ITextRegionAccess getOriginalTextRegionAccess()

isModified

boolean isModified(org.eclipse.xtext.util.ITextRegion region)

Returns:

true IFF there is a modification between ITextRegion.getOffset() and offset+ITextRegion.getLength().

move

void move(IHiddenRegion insertAt,
          IHiddenRegion substituteFirst,
          IHiddenRegion substituteLast)

remove

void remove(IHiddenRegion first,
            IHiddenRegion last)

remove

void remove(ISemanticRegion region)

replace

void replace(IHiddenRegion first,
             IHiddenRegion last,
             IHiddenRegion substituteFirst,
             IHiddenRegion substituteLast)

replace

void replace(IHiddenRegion first,
             IHiddenRegion last,
             ITextRegionAccess substitute)

replace

void replace(ISemanticRegion region,
             java.lang.String newText)

replaceSequence

ISequenceAcceptor replaceSequence(IHiddenRegion first,
                                  IHiddenRegion last,
                                  ISerializationContext ctx,
                                  org.eclipse.emf.ecore.EObject root)