org.eclipse.xtext.formatting2

Class FormatterRequest

java.lang.Object

org.eclipse.xtext.formatting2.FormatterRequest

public class FormatterRequest
extends Object

A request tells the formatter what and how to format.

When invoking the formatter, the request is passed into IFormatter2.format(FormatterRequest).

A request carries information about:

• The textRegionAccess which allows to obtain the to-be-formatted semantic model with text regions.
• Preferences with keys from e.g. FormatterPreferenceKeys.
• regions that describe how to restrict the text regions for which replacements are produced.
• An option to allowIdentityEdits() which will disable automated suppression of text replacements that do not cause changes.
• A setting for green-field formatting (formatUndefinedHiddenRegionsOnly): only format regions that have no whitespace information yet.

Since:

2.8

Author:

Moritz Eysholdt - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
FormatterRequest()

Method Summary

Methods

Modifier and Type	Method and Description
FormatterRequest	addRegion(ITextRegion region)
boolean	allowIdentityEdits()
IAcceptor<Exception>	getExceptionHandler()
ITypedPreferenceValues	getPreferences()
Collection<ITextRegion>	getRegions()
ITextRegionAccess	getTextRegionAccess()
boolean	isFormatUndefinedHiddenRegionsOnly()
FormatterRequest	setAllowIdentityEdits(boolean allowIdentityEdits)
FormatterRequest	setExceptionHandler(IAcceptor<Exception> problemHandler)
FormatterRequest	setFormatUndefinedHiddenRegionsOnly(boolean formatUndefinedHiddenRegionsOnly)
FormatterRequest	setPreferences(ITypedPreferenceValues preferenceValues)
FormatterRequest	setRegions(Collection<ITextRegion> regions)
FormatterRequest	setTextRegionAccess(ITextRegionAccess tokens) Sets the textRegionAccess.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormatterRequest

public FormatterRequest()

Method Detail

addRegion

public FormatterRequest addRegion(ITextRegion region)

See Also:

regions

setRegions

public FormatterRequest setRegions(Collection<ITextRegion> regions)

See Also:

regions

getRegions

public Collection<ITextRegion> getRegions()

See Also:

regions

getTextRegionAccess

public ITextRegionAccess getTextRegionAccess()

See Also:

textRegionAccess

setTextRegionAccess

public FormatterRequest setTextRegionAccess(ITextRegionAccess tokens)

Sets the textRegionAccess. If the region has syntax errors and no explicit ExceptionAcceptor is configured yet, the ignoring acceptor will be configured.

setAllowIdentityEdits

public FormatterRequest setAllowIdentityEdits(boolean allowIdentityEdits)

See Also:

allowIdentityEdits

allowIdentityEdits

public boolean allowIdentityEdits()

See Also:

allowIdentityEdits

setPreferences

public FormatterRequest setPreferences(ITypedPreferenceValues preferenceValues)

See Also:

preferences

getPreferences

public ITypedPreferenceValues getPreferences()

See Also:

preferences

isFormatUndefinedHiddenRegionsOnly

public boolean isFormatUndefinedHiddenRegionsOnly()

See Also:

formatUndefinedHiddenRegionsOnly

setFormatUndefinedHiddenRegionsOnly

public FormatterRequest setFormatUndefinedHiddenRegionsOnly(boolean formatUndefinedHiddenRegionsOnly)

See Also:

formatUndefinedHiddenRegionsOnly

getExceptionHandler

public IAcceptor<Exception> getExceptionHandler()

See Also:

exceptionHandler

setExceptionHandler

public FormatterRequest setExceptionHandler(IAcceptor<Exception> problemHandler)

See Also:

exceptionHandler