org.eclipse.xtext.formatting2.regionaccess.internal

Class AbstractHiddenRegion

java.lang.Object

org.eclipse.xtext.formatting2.regionaccess.internal.AbstractTextSegment

org.eclipse.xtext.formatting2.regionaccess.internal.AbstractHiddenRegion

All Implemented Interfaces:

Comparable<ITextSegment>, IHiddenRegion, ISequentialRegion, ITextSegment, ITextRegion

Direct Known Subclasses:

NodeHiddenRegion, StringHiddenRegion

public abstract class AbstractHiddenRegion
extends AbstractTextSegment
implements IHiddenRegion

Author:

Moritz Eysholdt - Initial contribution and API

Field Summary

Fields inherited from interface org.eclipse.xtext.util.ITextRegion

EMPTY_REGION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHiddenRegion(ITextRegionAccess access)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addPart(IHiddenRegionPart part)
protected List<ITextSegment>	collectAlternatingSpaceAndComments(boolean includeComments)
boolean	containsComment()
List<ITextSegment>	getAlternatingMergedSpaceAndComments()
int	getLength()
List<ITextSegment>	getMergedSpaces()
IHiddenRegion	getNextHiddenRegion()
ISemanticRegion	getNextSemanticRegion()
int	getOffset()
List<IHiddenRegionPart>	getParts()
IHiddenRegion	getPreviousHiddenRegion()
ISemanticRegion	getPreviousSemanticRegion()
ITextRegionAccess	getTextRegionAccess()
ISemanticRegionFinder	immediatelyFollowing()
ISemanticRegionFinder	immediatelyPreceding()
protected void	setNext(ISemanticRegion next)
protected void	setPrevious(ISemanticRegion previous)
String	toString()

Methods inherited from class org.eclipse.xtext.formatting2.regionaccess.internal.AbstractTextSegment

compareTo, contains, contains, equals, getEndOffset, getLineCount, getLineRegions, getText, hashCode, isMultiline, merge, replaceWith

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.xtext.formatting2.regionaccess.IHiddenRegion

isUndefined

Methods inherited from interface org.eclipse.xtext.formatting2.regionaccess.ITextSegment

getEndOffset, getLineCount, getLineRegions, getText, isMultiline, merge, replaceWith

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.eclipse.xtext.util.ITextRegion

contains, contains

Constructor Detail

AbstractHiddenRegion

protected AbstractHiddenRegion(ITextRegionAccess access)

Method Detail

addPart

protected void addPart(IHiddenRegionPart part)

collectAlternatingSpaceAndComments

protected List<ITextSegment> collectAlternatingSpaceAndComments(boolean includeComments)

containsComment

public boolean containsComment()

Specified by:

containsComment in interface IHiddenRegion

Returns:

true, if IHiddenRegion.getParts() contains at least one IComment.

getAlternatingMergedSpaceAndComments

public List<ITextSegment> getAlternatingMergedSpaceAndComments()

Specified by:

getAlternatingMergedSpaceAndComments in interface IHiddenRegion

Returns:

returns a list that starts with whitespace, ends with whitespace and contains a sequence of strictly alternating whitespace- and comment-regions.

getLength

public int getLength()

Specified by:

getLength in interface ITextRegion

getNextHiddenRegion

public IHiddenRegion getNextHiddenRegion()

Specified by:

getNextHiddenRegion in interface ISequentialRegion

getNextSemanticRegion

public ISemanticRegion getNextSemanticRegion()

Specified by:

getNextSemanticRegion in interface ISequentialRegion

getOffset

public int getOffset()

Specified by:

getOffset in interface ITextRegion

getParts

public List<IHiddenRegionPart> getParts()

Specified by:

getParts in interface IHiddenRegion

Returns:

all white spaces and comments that belong to this IHiddenRegion.

getPreviousHiddenRegion

public IHiddenRegion getPreviousHiddenRegion()

Specified by:

getPreviousHiddenRegion in interface ISequentialRegion

getPreviousSemanticRegion

public ISemanticRegion getPreviousSemanticRegion()

Specified by:

getPreviousSemanticRegion in interface ISequentialRegion

getMergedSpaces

public List<ITextSegment> getMergedSpaces()

Specified by:

getMergedSpaces in interface IHiddenRegion

getTextRegionAccess

public ITextRegionAccess getTextRegionAccess()

Specified by:

getTextRegionAccess in interface ITextSegment

setNext

protected void setNext(ISemanticRegion next)

setPrevious

protected void setPrevious(ISemanticRegion previous)

toString

public String toString()

Overrides:

toString in class Object

immediatelyFollowing

public ISemanticRegionFinder immediatelyFollowing()

Specified by:

immediatelyFollowing in interface ISequentialRegion

immediatelyPreceding

public ISemanticRegionFinder immediatelyPreceding()

Specified by:

immediatelyPreceding in interface ISequentialRegion