org.eclipse.xtext.generator.trace

Class AbstractTraceRegion

java.lang.Object

org.eclipse.xtext.generator.trace.AbstractTraceRegion

Direct Known Subclasses:

AbstractStatefulTraceRegion

public abstract class AbstractTraceRegion
extends Object

Abstract base class for trace regions. Implements the equals(Object) and hashCode() contract and delegates some functionality to the parent.

Author:

Sebastian Zarnekow - Initial contribution and API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTraceRegion(AbstractTraceRegion parent) Creates a new trace region and adds it to the parent if a parent was given.

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<SourceRelativeURI,List<Pair<ILocationData,AbstractTraceRegion>>>	collectMatchingLocations(SourceRelativeURI expectedAssociatedPath)
LocationData	createLocationData(AbstractTraceRegion region, SourceRelativeURI myPath)
boolean	equals(Object obj) Compares the specified object with this region for equality.
String	getAnnotatedString(String input)
abstract List<ILocationData>	getAssociatedLocations()
SourceRelativeURI	getAssociatedSrcRelativePath()
protected List<Pair<ILocationData,AbstractTraceRegion>>	getCollectingList(SourceRelativeURI associatedPath, SourceRelativeURI expectedAssociatedPath, Map<SourceRelativeURI,List<Pair<ILocationData,AbstractTraceRegion>>> listsPerURI)
ILocationData	getMergedAssociatedLocation() Returns the merged location of all associated locations if they belong to the same resource.
abstract int	getMyEndLineNumber()
abstract int	getMyLength()
abstract int	getMyLineNumber()
abstract int	getMyOffset()
ITextRegionWithLineInformation	getMyRegion()
List<AbstractTraceRegion>	getNestedRegions() Returns the nested trace regions.
AbstractTraceRegion	getParent()
AbstractTraceRegion	getRoot()
protected List<AbstractTraceRegion>	getWritableNestedRegions()
int	hashCode() Returns the hash code value for this region.
protected void	inplaceSortByOffset(List<Pair<ILocationData,AbstractTraceRegion>> locations)
Map<SourceRelativeURI,List<AbstractTraceRegion>>	invertAll(SourceRelativeURI myPath)
List<AbstractTraceRegion>	invertFor(SourceRelativeURI expectedAssociatedPath, SourceRelativeURI myPath)
protected boolean	isConsistentWithParent()
abstract boolean	isUseForDebugging()
Iterator<AbstractTraceRegion>	leafIterator() Returns an iterator that will only offer leaf trace regions.
static AbstractTraceRegion	mergedFrom(List<AbstractTraceRegion> regions)
protected void	setAsChildIn(AbstractTraceRegion parent)
void	setParent(AbstractTraceRegion parent) Sets the parent (if any) and maintains the nested regions of the parent.
protected List<AbstractTraceRegion>	toInvertedTraceRegions(List<Pair<ILocationData,AbstractTraceRegion>> locations, SourceRelativeURI myPath) Produces trees from a sorted list of locations.
String	toString()
org.eclipse.emf.common.util.TreeIterator<AbstractTraceRegion>	treeIterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTraceRegion

protected AbstractTraceRegion(AbstractTraceRegion parent)

Creates a new trace region and adds it to the parent if a parent was given.

Method Detail

isConsistentWithParent

protected boolean isConsistentWithParent()

setParent

public void setParent(AbstractTraceRegion parent)

Sets the parent (if any) and maintains the nested regions of the parent.

Parameters:

parent - the parent or null if none.

See Also:

setAsChildIn(AbstractTraceRegion)

setAsChildIn

protected void setAsChildIn(AbstractTraceRegion parent)

getNestedRegions

public final List<AbstractTraceRegion> getNestedRegions()

Returns the nested trace regions. The list does not necessarily contain all the regions that will be returned by the leafIterator().

Returns:

the list of directly nested regions.

getWritableNestedRegions

protected final List<AbstractTraceRegion> getWritableNestedRegions()

invertFor

public List<AbstractTraceRegion> invertFor(SourceRelativeURI expectedAssociatedPath,
                                  SourceRelativeURI myPath)

invertAll

public Map<SourceRelativeURI,List<AbstractTraceRegion>> invertAll(SourceRelativeURI myPath)

collectMatchingLocations

protected Map<SourceRelativeURI,List<Pair<ILocationData,AbstractTraceRegion>>> collectMatchingLocations(SourceRelativeURI expectedAssociatedPath)

getCollectingList

protected List<Pair<ILocationData,AbstractTraceRegion>> getCollectingList(SourceRelativeURI associatedPath,
                                                              SourceRelativeURI expectedAssociatedPath,
                                                              Map<SourceRelativeURI,List<Pair<ILocationData,AbstractTraceRegion>>> listsPerURI)

treeIterator

public org.eclipse.emf.common.util.TreeIterator<AbstractTraceRegion> treeIterator()

inplaceSortByOffset

protected void inplaceSortByOffset(List<Pair<ILocationData,AbstractTraceRegion>> locations)

toInvertedTraceRegions

protected List<AbstractTraceRegion> toInvertedTraceRegions(List<Pair<ILocationData,AbstractTraceRegion>> locations,
                                               SourceRelativeURI myPath)

Produces trees from a sorted list of locations. If the locations overlap, they'll be splitted automatically to fulfill the contract of invariant of trace regions.

mergedFrom

public static AbstractTraceRegion mergedFrom(List<AbstractTraceRegion> regions)

createLocationData

public LocationData createLocationData(AbstractTraceRegion region,
                              SourceRelativeURI myPath)

leafIterator

public final Iterator<AbstractTraceRegion> leafIterator()

Returns an iterator that will only offer leaf trace regions. If the nested regions have gaps, these will be filled with parent data. If this region is a leaf, a singleton iterator will be returned.

Returns:

an unmodifiable iterator for all leafs. Never null.

getMyLength

public abstract int getMyLength()

getMyOffset

public abstract int getMyOffset()

getMyLineNumber

public abstract int getMyLineNumber()

getMyEndLineNumber

public abstract int getMyEndLineNumber()

getMyRegion

public ITextRegionWithLineInformation getMyRegion()

getAssociatedLocations

public abstract List<ILocationData> getAssociatedLocations()

getMergedAssociatedLocation

public ILocationData getMergedAssociatedLocation()

Returns the merged location of all associated locations if they belong to the same resource. Otherwise null is returned.

getAssociatedSrcRelativePath

public SourceRelativeURI getAssociatedSrcRelativePath()

getParent

public AbstractTraceRegion getParent()

getRoot

public AbstractTraceRegion getRoot()

getAnnotatedString

public String getAnnotatedString(String input)

isUseForDebugging

public abstract boolean isUseForDebugging()

hashCode

public int hashCode()

Returns the hash code value for this region. The hash code of a trace region r is defined to be:

 r.getMyOffset() ^ r.getMyLength() ^ r.getAssociatedOffset() ^ r.getAssociatedLength()
                ^ (r.getParent() == null ? 0 : r.getParent().hashCode())
 

This ensures that r1.equals(r2) implies that r1.hashCode()==r2.hashCode() for any two AbstractTraceRegion r1 and r2, as required by the general contract of Object.hashCode.

Overrides:

hashCode in class Object

Returns:

the hash code value for this trace region

See Also:

Object.hashCode(), Object.equals(Object), equals(Object)

equals

public boolean equals(Object obj)

Compares the specified object with this region for equality. Returns true if the given object is also an AbstractTraceRegion and the two regions represent the same data. More formally, two regions r1 and r2 are considered to be equal if

 (r1.getMyOffset() == r2.getMyOffset()) && (r1.getMyLength() == r2.getMyLength())
                && (r1.getAssociatedOffset() == r2.getAssociatedOffset())
                && (r1.getAssociatedLength() == r2.getAssociatedLength())
                && (r1.getParent() == null ? r2.getParent() == null : r1.getParent().equals(r2.getParent()))
 

This ensures that the equals(Object) method works properly across different implementations of the AbstractTraceRegion interface.

Overrides:

equals in class Object

Parameters:

obj - object to be compared for equality with this trace region

Returns:

true if the specified object is equal to this trace region

toString

public String toString()

Overrides:

toString in class Object