Package org.eclipse.xtext.xbase.compiler.output

Interface ITreeAppendable

All Superinterfaces:

IAppendable, ISourceAppender, org.eclipse.xtext.generator.trace.ITraceRegionProvider

All Known Implementing Classes:

ErrorTreeAppendable, FakeTreeAppendable, TreeAppendable

public interface ITreeAppendable
extends IAppendable, org.eclipse.xtext.generator.trace.ITraceRegionProvider

A specialized appendable that can be used to trace the source location for the written output.

Method Summary

Modifier and Type	Method	Description
ITreeAppendable	append(java.lang.CharSequence content)	Appends the specified character sequence to this ITreeAppendable.
ITreeAppendable	append(java.lang.Class<?> type)
ITreeAppendable	append(org.eclipse.xtext.common.types.JvmType type)
ITreeAppendable	append(LightweightTypeReference typeRef)
default ITreeAppendable	blankLine()	Defaults to newLine() but can be customized to behave differently, for example, to insert a blank line without indentation.
ITreeAppendable	decreaseIndentation()
ErrorTreeAppendable	errorChild()
ITreeAppendable	increaseIndentation()
ITreeAppendable	newLine()
ITreeAppendable	trace(java.lang.Iterable<? extends org.eclipse.emf.ecore.EObject> objects)
ITreeAppendable	trace(org.eclipse.emf.ecore.EObject object)	same as trace(object, false)
ITreeAppendable	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)
ITreeAppendable	trace(org.eclipse.xtext.generator.trace.ILocationData location)
ITreeAppendable	trace(org.eclipse.xtext.generator.trace.ILocationData location, boolean useForDebugging)

Methods inherited from interface org.eclipse.xtext.xbase.compiler.IAppendable

closeScope, declareSyntheticVariable, declareUniqueNameVariable, declareVariable, getContent, getGeneratorConfig, getImports, getName, getObject, hasName, hasObject, length, openPseudoScope, openScope, removeName, toString

Methods inherited from interface org.eclipse.xtext.xbase.compiler.ISourceAppender

isJava

Methods inherited from interface org.eclipse.xtext.generator.trace.ITraceRegionProvider

getTraceRegion

Method Detail

trace

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

Parameters:

object - the object this part should be associated with

useForDebugging - whether the part is relevant for debugging

trace

ITreeAppendable trace(org.eclipse.emf.ecore.EObject object)

same as trace(object, false)

trace

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

Parameters:

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

trace

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

trace

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

trace

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

Parameters:

location - the location that should be traced

useForDebugging - whether the part is relevant for debugging

errorChild

ErrorTreeAppendable errorChild()

append

ITreeAppendable append(org.eclipse.xtext.common.types.JvmType type)

Specified by:

append in interface IAppendable

Specified by:

append in interface ISourceAppender

append

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

append

ITreeAppendable append(LightweightTypeReference typeRef)

Specified by:

append in interface IAppendable

Specified by:

append in interface ISourceAppender

append

ITreeAppendable append(java.lang.CharSequence content)

Appends the specified character sequence to this ITreeAppendable.

Specified by:

append in interface IAppendable

Specified by:

append in interface ISourceAppender

Parameters:

content - - not null

Returns:

reference to an ITreeAppendable where the given content got appended

decreaseIndentation

ITreeAppendable decreaseIndentation()

Specified by:

decreaseIndentation in interface IAppendable

Specified by:

decreaseIndentation in interface ISourceAppender

increaseIndentation

ITreeAppendable increaseIndentation()

Specified by:

increaseIndentation in interface IAppendable

Specified by:

increaseIndentation in interface ISourceAppender

newLine

ITreeAppendable newLine()

Specified by:

newLine in interface IAppendable

Specified by:

newLine in interface ISourceAppender

blankLine

default ITreeAppendable blankLine()

Defaults to newLine() but can be customized to behave differently, for example, to insert a blank line without indentation.

Since:

2.27