Package net.ssehub.easy.instantiation.core.model.templateModel

Class StreamTracer

java.lang.Object

net.ssehub.easy.instantiation.core.model.expressions.AbstractWriter

net.ssehub.easy.instantiation.core.model.expressions.StreamTracer

net.ssehub.easy.instantiation.core.model.common.StreamTracer

net.ssehub.easy.instantiation.core.model.templateModel.StreamTracer

All Implemented Interfaces:

ITracer, ITracer, ITracer

public class StreamTracer
extends StreamTracer
implements ITracer

Implements a simple stream-based execution tracer. Produces normalized sequences of collections in order to facilitate easy comparison. As this may affect followup computations, don't use this tracer for real execution!

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	emitFailed

Fields inherited from class net.ssehub.easy.instantiation.core.model.expressions.StreamTracer

NORMALIZER

Constructor Summary

Constructors

Constructor	Description
StreamTracer(java.io.Writer out, boolean emitFailed, java.lang.String... baseFolder)	Creates a new stream tracer.
StreamTracer(java.io.Writer out, java.lang.String... baseFolder)	Creates a new stream tracer.

Method Summary

Modifier and Type	Method	Description
void	failedAt(ITemplateLangElement element)	Is called when the execution of a template language element failed.
protected ExpressionWriter	getWriter(java.io.Writer out)	Returns the writer for emitting expressions.
void	visitAlternative(boolean takeIf)	An alternative was visited.
void	visitDef(Def def, RuntimeEnvironment<?,?> environment)	Starts visiting a sub-template.
void	visitedDef(Def def, RuntimeEnvironment<?,?> environment, java.lang.Object result)	Ends visiting a sub-template.
void	visitedFlush()	Is called after a content flush.
void	visitedLoop(VariableDeclaration var)	Visiting a loop ended.
void	visitedSwitch(java.lang.Object select, int alternative, java.lang.Object value)	A switch statement was visited.
void	visitedTemplate(Template template)	Ends visiting a template.
void	visitedWhileBody()	Is called at the end of a while body being visited.
void	visitFlush()	Is called before a content flush.
void	visitLoop(VariableDeclaration var)	Visiting a loop started.
void	visitTemplate(Template template)	Starts visiting a template.
void	visitWhileBody()	Is called at the beginning of a while body being visited.

Methods inherited from class net.ssehub.easy.instantiation.core.model.common.StreamTracer

enable, isEnabled, printValueDefined, trace, traceError, traceExecutionException, traceWarning, valueDefined

Methods inherited from class net.ssehub.easy.instantiation.core.model.expressions.StreamTracer

failedAt, getLocale, getRuntimeEnvironment, makeRelative, makeRelative, makeRelative, setLocale, setRuntimeEnvironment, visitedCallExpression, visitingCallExpression

Methods inherited from class net.ssehub.easy.instantiation.core.model.expressions.AbstractWriter

decreaseIndentation, flush, getOut, increaseIndentation, print, print, print, print, printIndentation, printJavaEscaped, println, println, println, println, println, printWhitespace, setIndentation

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ssehub.easy.instantiation.core.model.common.ITracer

enable, trace, traceError, traceExecutionException, traceWarning, valueDefined

Methods inherited from interface net.ssehub.easy.instantiation.core.model.expressions.ITracer

failedAt, getLocale, getRuntimeEnvironment, setLocale, setRuntimeEnvironment, visitedCallExpression, visitingCallExpression

Field Detail

emitFailed

private boolean emitFailed

Constructor Detail

StreamTracer

public StreamTracer(java.io.Writer out,
                    java.lang.String... baseFolder)

Creates a new stream tracer.

Parameters:

out - the output writer

baseFolder - optional base folders used to make matching (string) values relative

StreamTracer

public StreamTracer(java.io.Writer out,
                    boolean emitFailed,
                    java.lang.String... baseFolder)

Creates a new stream tracer.

Parameters:

out - the output writer

emitFailed - whether failure causes shall be emitted

baseFolder - optional base folders used to make matching (string) values relative

Method Detail

visitDef

public void visitDef(Def def,
                     RuntimeEnvironment<?,?> environment)

Description copied from interface: ITracer

Starts visiting a sub-template.

Specified by:

visitDef in interface ITracer

Parameters:

def - the sub-template

environment - the runtime environment

visitedDef

public void visitedDef(Def def,
                       RuntimeEnvironment<?,?> environment,
                       java.lang.Object result)

Description copied from interface: ITracer

Ends visiting a sub-template.

Specified by:

visitedDef in interface ITracer

Parameters:

def - the sub-template

environment - the runtime environment

result - the execution result

visitedSwitch

public void visitedSwitch(java.lang.Object select,
                          int alternative,
                          java.lang.Object value)

Description copied from interface: ITracer

A switch statement was visited.

Specified by:

visitedSwitch in interface ITracer

Parameters:

select - the select value

alternative - the successive alternative (0-based index including default)

value - the actual value of the switch statement

visitLoop

public void visitLoop(VariableDeclaration var)

Description copied from interface: ITracer

Visiting a loop started.

Specified by:

visitLoop in interface ITracer

Parameters:

var - the loop/iterator variable

visitedLoop

public void visitedLoop(VariableDeclaration var)

Description copied from interface: ITracer

Visiting a loop ended.

Specified by:

visitedLoop in interface ITracer

Parameters:

var - the loop/iterator variable

visitAlternative

public void visitAlternative(boolean takeIf)

Description copied from interface: ITracer

An alternative was visited.

Specified by:

visitAlternative in interface ITracer

Parameters:

takeIf - if true the if-branch is used, false else the else-branch

failedAt

public void failedAt(ITemplateLangElement element)

Description copied from interface: ITracer

Is called when the execution of a template language element failed.

Specified by:

failedAt in interface ITracer

Parameters:

element - the failed element

getWriter

protected ExpressionWriter getWriter(java.io.Writer out)

Description copied from class: StreamTracer

Returns the writer for emitting expressions.

Specified by:

getWriter in class StreamTracer

Parameters:

out - the output target

Returns:

the writer

visitTemplate

public void visitTemplate(Template template)

Description copied from interface: ITracer

Starts visiting a template.

Specified by:

visitTemplate in interface ITracer

Parameters:

template - the template being visited

visitedTemplate

public void visitedTemplate(Template template)

Description copied from interface: ITracer

Ends visiting a template.

Specified by:

visitedTemplate in interface ITracer

Parameters:

template - the template

visitWhileBody

public void visitWhileBody()

Description copied from interface: ITracer

Is called at the beginning of a while body being visited.

Specified by:

visitWhileBody in interface ITracer

visitedWhileBody

public void visitedWhileBody()

Description copied from interface: ITracer

Is called at the end of a while body being visited.

Specified by:

visitedWhileBody in interface ITracer

visitFlush

public void visitFlush()

Description copied from interface: ITracer

Is called before a content flush.

Specified by:

visitFlush in interface ITracer

visitedFlush

public void visitedFlush()

Description copied from interface: ITracer

Is called after a content flush.

Specified by:

visitedFlush in interface ITracer