org.eclipse.xtext.formatting2.regionaccess

Interface ITextRegionRewriter

All Known Implementing Classes:

TextRegionRewriter

public interface ITextRegionRewriter

Use ITextRegionAccess.getRewriter() to obtain an instance implementing this interface.

Author:

Moritz Eysholdt - Initial contribution and API

Method Summary

Methods

Modifier and Type	Method and Description
ITextReplacement	createReplacement(int offset, int length, String text)
void	renderToAppendable(Iterable<? extends ITextReplacement> replacements, Appendable result)
void	renderToAppendable(ITextSegment segment, Iterable<? extends ITextReplacement> replacements, Appendable result)
String	renderToString(Iterable<? extends ITextReplacement> replacements) Applies all 'replacements' on the ITextRegionAccess this rewriter is responsible for.
String	renderToString(ITextSegment input, Iterable<? extends ITextReplacement> replacements) Applies replacements similar to renderToString(Iterable), but ITextRegion.getOffset() is treated as relative to ITextRegion.getOffset() from 'input'.

Method Detail

renderToAppendable

void renderToAppendable(Iterable<? extends ITextReplacement> replacements,
                      Appendable result)
                        throws IOException

Throws:

IOException

createReplacement

ITextReplacement createReplacement(int offset,
                                 int length,
                                 String text)

renderToAppendable

void renderToAppendable(ITextSegment segment,
                      Iterable<? extends ITextReplacement> replacements,
                      Appendable result)
                        throws IOException

Throws:

IOException

renderToString

String renderToString(Iterable<? extends ITextReplacement> replacements)

Applies all 'replacements' on the ITextRegionAccess this rewriter is responsible for.

Replaces the text regions in 'input' identified by ITextRegion.getOffset() and ITextRegion.getLength() with ITextReplacement.getReplacementText().

Returns:

The text after the replacements have been applied.

renderToString

String renderToString(ITextSegment input,
                    Iterable<? extends ITextReplacement> replacements)

Applies replacements similar to renderToString(Iterable), but ITextRegion.getOffset() is treated as relative to ITextRegion.getOffset() from 'input'.