org.eclipse.xtext.xbase.compiler.output

Class TreeAppendable

java.lang.Object

org.eclipse.xtext.xbase.compiler.output.TreeAppendable

All Implemented Interfaces:

java.lang.CharSequence, org.eclipse.xtext.generator.trace.ITraceRegionProvider, org.eclipse.xtext.util.IAcceptor<java.lang.String>, IAppendable, ISourceAppender, ITreeAppendable

Direct Known Subclasses:

ErrorTreeAppendable

public class TreeAppendable
extends java.lang.Object
implements ITreeAppendable, org.eclipse.xtext.util.IAcceptor<java.lang.String>, java.lang.CharSequence

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeAppendable.Visitor A visitor can be used to manipulate an existing TreeAppendable or to create a completely new one recursively.

Constructor Summary

Constructors

Modifier	Constructor and Description
	TreeAppendable(ImportManager importManager, org.eclipse.xtext.generator.trace.ITraceURIConverter converter, org.eclipse.xtext.resource.ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, org.eclipse.emf.ecore.EObject source, java.lang.String indentation, java.lang.String lineSeparator)
protected	TreeAppendable(SharedAppendableState state, org.eclipse.xtext.generator.trace.ITraceURIConverter converter, org.eclipse.xtext.resource.ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, org.eclipse.emf.ecore.EObject source)
protected	TreeAppendable(SharedAppendableState state, org.eclipse.xtext.generator.trace.ITraceURIConverter converter, org.eclipse.xtext.resource.ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> sourceLocations, boolean useForDebugging)

Method Summary

Modifier and Type	Method and Description
void	accept(java.lang.String text)
TreeAppendable	acceptVisitor(TreeAppendable.Visitor visitor)
ITreeAppendable	append(java.lang.CharSequence content) Appends the specified character sequence to this ITreeAppendable.
ITreeAppendable	append(java.lang.Class<?> type)
TreeAppendable	append(org.eclipse.xtext.common.types.JvmType type)
ITreeAppendable	append(LightweightTypeReference typeRef)
protected void	appendIndented(java.lang.String text)
protected ITreeAppendable	appendTreeAppendable(ITreeAppendable other)
TreeAppendable	appendUnsafe(java.lang.String string)
char	charAt(int index)
protected void	closeLastChild()
void	closeScope()
protected static java.util.Set<org.eclipse.xtext.generator.trace.ILocationData>	createAllLocationData(org.eclipse.xtext.generator.trace.ITraceURIConverter converter, org.eclipse.xtext.resource.ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, org.eclipse.emf.ecore.EObject object, org.eclipse.xtext.resource.ILocationInFileProviderExtension.RegionDescription query, boolean skipEmpty)
protected TreeAppendable	createChild(SharedAppendableState state, org.eclipse.xtext.resource.ILocationInFileProvider locationProvider, IJvmModelAssociations jvmModelAssociations, java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> newData, boolean useForDebugging)
protected LightweightTypeReferenceSerializer	createLightweightTypeReferenceSerializer()
protected static org.eclipse.xtext.generator.trace.ILocationData	createLocationData(org.eclipse.xtext.generator.trace.ITraceURIConverter converter, org.eclipse.emf.ecore.EObject object, org.eclipse.xtext.util.ITextRegionWithLineInformation textRegion)
protected static org.eclipse.xtext.generator.trace.ILocationData	createLocationData(org.eclipse.xtext.generator.trace.ITraceURIConverter converter, org.eclipse.xtext.resource.ILocationInFileProvider locationProvider, org.eclipse.emf.ecore.EObject object, org.eclipse.xtext.resource.ILocationInFileProviderExtension.RegionDescription query)
java.lang.String	declareSyntheticVariable(java.lang.Object key, java.lang.String proposedName) Declares a synthetic variable, where the name is not used in the current or any parent scope except by other synthetic variables.
java.lang.String	declareUniqueNameVariable(java.lang.Object key, java.lang.String proposedName) Declares a variable with unique name, which is not used in the current or any parent scope.
java.lang.String	declareVariable(java.lang.Object key, java.lang.String proposedName)
TreeAppendable	decreaseIndentation()
protected void	doGetContent(java.lang.StringBuilder result)
void	dump()
protected void	dump(java.lang.String indent)
ErrorTreeAppendable	errorChild()
java.util.List<? extends java.lang.Object>	getChildren() Access the children of the TreeAppendable.
java.lang.String	getContent()
GeneratorConfig	getGeneratorConfig()
java.util.List<java.lang.String>	getImports() Deprecated.
java.util.Set<org.eclipse.xtext.generator.trace.ILocationData>	getLocationData()
java.lang.String	getName(java.lang.Object key)
java.lang.Object	getObject(java.lang.String name)
SharedAppendableState	getState()
org.eclipse.xtext.generator.trace.AbstractTraceRegion	getTraceRegion()
org.eclipse.xtext.generator.trace.ITraceURIConverter	getTraceURIConverter()
boolean	hasName(java.lang.Object key)
boolean	hasObject(java.lang.String name)
TreeAppendable	increaseIndentation()
protected boolean	isClosed()
boolean	isJava()
boolean	isUseForDebugging()
int	length()
protected void	markClosed()
TreeAppendable	newLine()
void	openPseudoScope() opens a new variable scope, without having a new Java scope.
void	openScope() opens a new scope, backed up by a real Java Scope
java.lang.String	removeName(java.lang.Object key)
java.lang.CharSequence	subSequence(int start, int end)
java.lang.String	toString()
TreeAppendable	trace(org.eclipse.emf.ecore.EObject object) same as trace(object, false)
TreeAppendable	trace(org.eclipse.emf.ecore.EObject object, boolean useForDebugging)
ITreeAppendable	trace(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.ecore.EStructuralFeature feature, int indexInList)
TreeAppendable	trace(org.eclipse.emf.ecore.EObject object, org.eclipse.xtext.resource.ILocationInFileProviderExtension.RegionDescription region, boolean useForDebugging)
ITreeAppendable	trace(org.eclipse.xtext.generator.trace.ILocationData location)
ITreeAppendable	trace(org.eclipse.xtext.generator.trace.ILocationData location, boolean useForDebugging)
ITreeAppendable	trace(java.lang.Iterable<? extends org.eclipse.emf.ecore.EObject> objects)
protected TreeAppendable	trace(java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> newData, boolean useForDebugging)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

TreeAppendable

public TreeAppendable(ImportManager importManager,
                      org.eclipse.xtext.generator.trace.ITraceURIConverter converter,
                      org.eclipse.xtext.resource.ILocationInFileProvider locationProvider,
                      IJvmModelAssociations jvmModelAssociations,
                      org.eclipse.emf.ecore.EObject source,
                      java.lang.String indentation,
                      java.lang.String lineSeparator)

TreeAppendable

protected TreeAppendable(SharedAppendableState state,
                         org.eclipse.xtext.generator.trace.ITraceURIConverter converter,
                         org.eclipse.xtext.resource.ILocationInFileProvider locationProvider,
                         IJvmModelAssociations jvmModelAssociations,
                         org.eclipse.emf.ecore.EObject source)

TreeAppendable

protected TreeAppendable(SharedAppendableState state,
                         org.eclipse.xtext.generator.trace.ITraceURIConverter converter,
                         org.eclipse.xtext.resource.ILocationInFileProvider locationProvider,
                         IJvmModelAssociations jvmModelAssociations,
                         java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> sourceLocations,
                         boolean useForDebugging)

Method Detail

createLightweightTypeReferenceSerializer

protected LightweightTypeReferenceSerializer createLightweightTypeReferenceSerializer()

isJava

public boolean isJava()

Specified by:

isJava in interface ISourceAppender

getTraceURIConverter

public org.eclipse.xtext.generator.trace.ITraceURIConverter getTraceURIConverter()

errorChild

public ErrorTreeAppendable errorChild()

Specified by:

errorChild in interface ITreeAppendable

Since:

2.4

trace

public TreeAppendable trace(org.eclipse.emf.ecore.EObject object)

Description copied from interface: ITreeAppendable

same as trace(object, false)

Specified by:

trace in interface ITreeAppendable

trace

public TreeAppendable trace(org.eclipse.emf.ecore.EObject object,
                            boolean useForDebugging)

Specified by:

trace in interface ITreeAppendable

Parameters:

object - the object this part should be associated with

useForDebugging - whether the part is relevant for debugging

trace

public TreeAppendable trace(org.eclipse.emf.ecore.EObject object,
                            org.eclipse.xtext.resource.ILocationInFileProviderExtension.RegionDescription region,
                            boolean useForDebugging)

trace

protected TreeAppendable trace(java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> newData,
                               boolean useForDebugging)

createChild

protected TreeAppendable createChild(SharedAppendableState state,
                                     org.eclipse.xtext.resource.ILocationInFileProvider locationProvider,
                                     IJvmModelAssociations jvmModelAssociations,
                                     java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> newData,
                                     boolean useForDebugging)

Since:

2.4

trace

public ITreeAppendable trace(org.eclipse.xtext.generator.trace.ILocationData location)

Specified by:

trace in interface ITreeAppendable

trace

public ITreeAppendable trace(org.eclipse.xtext.generator.trace.ILocationData location,
                             boolean useForDebugging)

Specified by:

trace in interface ITreeAppendable

Parameters:

location - the location that should be traced

useForDebugging - whether the part is relevant for debugging

createLocationData

protected static org.eclipse.xtext.generator.trace.ILocationData createLocationData(org.eclipse.xtext.generator.trace.ITraceURIConverter converter,
                                                                                    org.eclipse.xtext.resource.ILocationInFileProvider locationProvider,
                                                                                    org.eclipse.emf.ecore.EObject object,
                                                                                    org.eclipse.xtext.resource.ILocationInFileProviderExtension.RegionDescription query)

createAllLocationData

protected static java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> createAllLocationData(org.eclipse.xtext.generator.trace.ITraceURIConverter converter,
                                                                                                      org.eclipse.xtext.resource.ILocationInFileProvider locationProvider,
                                                                                                      IJvmModelAssociations jvmModelAssociations,
                                                                                                      org.eclipse.emf.ecore.EObject object,
                                                                                                      org.eclipse.xtext.resource.ILocationInFileProviderExtension.RegionDescription query,
                                                                                                      boolean skipEmpty)

trace

public ITreeAppendable trace(java.lang.Iterable<? extends org.eclipse.emf.ecore.EObject> objects)

Specified by:

trace in interface ITreeAppendable

Parameters:

objects - the iterable of EObjects that contribute output. May not be empty.

trace

public ITreeAppendable trace(org.eclipse.emf.ecore.EObject object,
                             org.eclipse.emf.ecore.EStructuralFeature feature,
                             int indexInList)

Specified by:

trace in interface ITreeAppendable

createLocationData

protected static org.eclipse.xtext.generator.trace.ILocationData createLocationData(org.eclipse.xtext.generator.trace.ITraceURIConverter converter,
                                                                                    org.eclipse.emf.ecore.EObject object,
                                                                                    org.eclipse.xtext.util.ITextRegionWithLineInformation textRegion)

acceptVisitor

public TreeAppendable acceptVisitor(TreeAppendable.Visitor visitor)

getLocationData

public java.util.Set<org.eclipse.xtext.generator.trace.ILocationData> getLocationData()

getChildren

public java.util.List<? extends java.lang.Object> getChildren()

Access the children of the TreeAppendable. The list contains either strings or other TreeAppendables. The list may be empty.

Returns:

the children of this appendable.

accept

public void accept(java.lang.String text)

Specified by:

accept in interface org.eclipse.xtext.util.IAcceptor<java.lang.String>

Noreference:

This method is not intended to be referenced by clients.

markClosed

protected void markClosed()

closeLastChild

protected void closeLastChild()

isClosed

protected boolean isClosed()

append

public TreeAppendable append(org.eclipse.xtext.common.types.JvmType type)

Specified by:

append in interface IAppendable

Specified by:

append in interface ISourceAppender

Specified by:

append in interface ITreeAppendable

append

public ITreeAppendable append(java.lang.Class<?> type)

Specified by:

append in interface ITreeAppendable

append

public ITreeAppendable append(LightweightTypeReference typeRef)

Specified by:

append in interface IAppendable

Specified by:

append in interface ISourceAppender

Specified by:

append in interface ITreeAppendable

appendTreeAppendable

protected ITreeAppendable appendTreeAppendable(ITreeAppendable other)

append

public ITreeAppendable append(java.lang.CharSequence content)

Description copied from interface: ITreeAppendable

Appends the specified character sequence to this ITreeAppendable.

Specified by:

append in interface IAppendable

Specified by:

append in interface ISourceAppender

Specified by:

append in interface ITreeAppendable

Parameters:

content - - not null

appendUnsafe

public TreeAppendable appendUnsafe(java.lang.String string)

newLine

public TreeAppendable newLine()

Specified by:

newLine in interface IAppendable

Specified by:

newLine in interface ISourceAppender

Specified by:

newLine in interface ITreeAppendable

increaseIndentation

public TreeAppendable increaseIndentation()

Specified by:

increaseIndentation in interface IAppendable

Specified by:

increaseIndentation in interface ISourceAppender

Specified by:

increaseIndentation in interface ITreeAppendable

decreaseIndentation

public TreeAppendable decreaseIndentation()

Specified by:

decreaseIndentation in interface IAppendable

Specified by:

decreaseIndentation in interface ISourceAppender

Specified by:

decreaseIndentation in interface ITreeAppendable

getImports

@Deprecated
public java.util.List<java.lang.String> getImports()

Deprecated.

Specified by:

getImports in interface IAppendable

openScope

public void openScope()

Description copied from interface: IAppendable

opens a new scope, backed up by a real Java Scope

Specified by:

openScope in interface IAppendable

openPseudoScope

public void openPseudoScope()

Description copied from interface: IAppendable

opens a new variable scope, without having a new Java scope.

Specified by:

openPseudoScope in interface IAppendable

declareVariable

public java.lang.String declareVariable(java.lang.Object key,
                                        java.lang.String proposedName)

Specified by:

declareVariable in interface IAppendable

declareSyntheticVariable

public java.lang.String declareSyntheticVariable(java.lang.Object key,
                                                 java.lang.String proposedName)

Description copied from interface: IAppendable

Declares a synthetic variable, where the name is not used in the current or any parent scope except by other synthetic variables.

Specified by:

declareSyntheticVariable in interface IAppendable

declareUniqueNameVariable

public java.lang.String declareUniqueNameVariable(java.lang.Object key,
                                                  java.lang.String proposedName)

Description copied from interface: IAppendable

Declares a variable with unique name, which is not used in the current or any parent scope. This is a workaround for https://bugs.eclipse.org/bugs/show_bug.cgi?id=445949

Specified by:

declareUniqueNameVariable in interface IAppendable

removeName

public java.lang.String removeName(java.lang.Object key)

Specified by:

removeName in interface IAppendable

getName

public java.lang.String getName(java.lang.Object key)

Specified by:

getName in interface IAppendable

hasName

public boolean hasName(java.lang.Object key)

Specified by:

hasName in interface IAppendable

getObject

public java.lang.Object getObject(java.lang.String name)

Specified by:

getObject in interface IAppendable

hasObject

public boolean hasObject(java.lang.String name)

Specified by:

hasObject in interface IAppendable

closeScope

public void closeScope()

Specified by:

closeScope in interface IAppendable

getContent

public java.lang.String getContent()

Specified by:

getContent in interface IAppendable

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

toString

public java.lang.String toString()

Specified by:

toString in interface java.lang.CharSequence

Specified by:

toString in interface IAppendable

Overrides:

toString in class java.lang.Object

doGetContent

protected void doGetContent(java.lang.StringBuilder result)

length

public int length()

Specified by:

length in interface java.lang.CharSequence

Specified by:

length in interface IAppendable

getTraceRegion

public org.eclipse.xtext.generator.trace.AbstractTraceRegion getTraceRegion()

Specified by:

getTraceRegion in interface org.eclipse.xtext.generator.trace.ITraceRegionProvider

appendIndented

protected void appendIndented(java.lang.String text)

isUseForDebugging

public boolean isUseForDebugging()

getState

public SharedAppendableState getState()

Since:

2.4

dump

public void dump()

Since:

2.4

Noreference:

This method is not intended to be referenced by clients.

Nooverride:

This method is not intended to be re-implemented or extended by clients.

dump

protected void dump(java.lang.String indent)

Since:

2.4

Noreference:

This method is not intended to be referenced by clients.

Nooverride:

This method is not intended to be re-implemented or extended by clients.

getGeneratorConfig

public GeneratorConfig getGeneratorConfig()

Specified by:

getGeneratorConfig in interface IAppendable