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

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

All Implemented Interfaces:

ITracer, ITracer

Direct Known Subclasses:

StreamTracer, StreamTracer

public abstract class StreamTracer
extends StreamTracer
implements ITracer

Implements a simple stream-based execution tracer. Produces normalized sequences of collections in order to facilitate easy comparison.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	enabled

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

NORMALIZER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	enable(boolean enable)	Enables or disables the tracer.
protected boolean	isEnabled()	Returns whether this tracer is enabled.
protected void	printValueDefined(VariableDeclaration var, FieldDescriptor field, java.lang.Object value)	Is prints a value definition.
void	trace(java.lang.String text)	Emits a trace string.
void	traceError(java.lang.String text)	Emits an error trace string.
void	traceExecutionException(VilException exception)	Traces a top-level execution exception, i.e., execution a VIL script or template failed.
void	traceWarning(java.lang.String text)	Emits a warning trace string.
void	valueDefined(VariableDeclaration var, FieldDescriptor field, java.lang.Object value)	Is called when a value of a variable is defined.

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

failedAt, getLocale, getRuntimeEnvironment, getWriter, 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.expressions.ITracer

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

Field Detail

enabled

private boolean enabled

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

Method Detail

trace

public void trace(java.lang.String text)

Description copied from interface: ITracer

Emits a trace string.

Specified by:

trace in interface ITracer

Parameters:

text - the text to be emitted

traceError

public void traceError(java.lang.String text)

Description copied from interface: ITracer

Emits an error trace string.

Specified by:

traceError in interface ITracer

Parameters:

text - the text to be emitted

traceWarning

public void traceWarning(java.lang.String text)

Description copied from interface: ITracer

Emits a warning trace string.

Specified by:

traceWarning in interface ITracer

Parameters:

text - the text to be emitted

valueDefined

public void valueDefined(VariableDeclaration var,
                         FieldDescriptor field,
                         java.lang.Object value)

Description copied from interface: ITracer

Is called when a value of a variable is defined.

Specified by:

valueDefined in interface ITracer

Parameters:

var - the modified variable

field - the field in var, may be null

value - the actual value

printValueDefined

protected void printValueDefined(VariableDeclaration var,
                                 FieldDescriptor field,
                                 java.lang.Object value)

Is prints a value definition.

Parameters:

var - the modified variable

field - the field in var, may be null

value - the actual value

traceExecutionException

public void traceExecutionException(VilException exception)

Description copied from interface: ITracer

Traces a top-level execution exception, i.e., execution a VIL script or template failed.

Specified by:

traceExecutionException in interface ITracer

Parameters:

exception - the exception

isEnabled

protected boolean isEnabled()

Returns whether this tracer is enabled.

Returns:

true for enabled, false else

enable

public void enable(boolean enable)

Description copied from interface: ITracer

Enables or disables the tracer. By default, a tracer is enabled.

Specified by:

enable in interface ITracer

Parameters:

enable - enable or disable