sirius.tagliatelle.emitter

Class ConstantEmitter

java.lang.Object

sirius.tagliatelle.emitter.Emitter

sirius.tagliatelle.emitter.ConstantEmitter

public class ConstantEmitter
extends Emitter

Emits a constant text block.

Field Summary

Fields

Modifier and Type	Field and Description
static ConstantEmitter	EMPTY Represents an empty emitter which does not contribute the the output.

Fields inherited from class sirius.tagliatelle.emitter.Emitter

startOfBlock

Constructor Summary

Constructors

Constructor and Description
ConstantEmitter(parsii.tokenizer.Position startOfBlock) Creates a new constant emitter at the given position.

Method Summary

Modifier and Type	Method and Description
ConstantEmitter	append(String stringToAppend) Appends the given string to the output.
Emitter	copy() Creates a copy of the emitter.
protected void	emitToContext(LocalRenderContext context) Actually produces the output while relying on the caller to properly handle any exception.
String	getValue() Returns the underlying text block which will be emitted.
Emitter	propagateVisitor(EmitterVisitor visitor) Invokes the visitor on all sub emitters and on this emitter itself.
Emitter	reduce() Performs static optimizations at compile time.
String	toString()
void	visitExpressions(Function<parsii.tokenizer.Position,ExpressionVisitor> visitorSupplier) Visits all expressions contained in this emitter or its children.

Methods inherited from class sirius.tagliatelle.emitter.Emitter

emit, getStartOfBlock

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ConstantEmitter EMPTY

Represents an empty emitter which does not contribute the the output.

Constructor Detail

ConstantEmitter

public ConstantEmitter(parsii.tokenizer.Position startOfBlock)

Creates a new constant emitter at the given position.

Parameters:

startOfBlock - the position where the emitter was created.

Method Detail

copy

public Emitter copy()

Creates a copy of the emitter.

Although the emitter is constant, we still need to create a copy, as the CompositeEmitter folds adjacent constant blocks into one.

Specified by:

copy in class Emitter

Returns:

a copy of this emitter

reduce

public Emitter reduce()

Description copied from class: Emitter

Performs static optimizations at compile time.

Certain emitters can perform optimizations (evaluate constant expressions, combine constant outputs etc.) to create more efficient templates. This is especially important when a template is inlined, as this most probably provides a higher level of optimizations.

Specified by:

reduce in class Emitter

Returns:

a reduced version of this emitter of the emitter itself, if no further optimizations are possible

propagateVisitor

public Emitter propagateVisitor(EmitterVisitor visitor)

Description copied from class: Emitter

Invokes the visitor on all sub emitters and on this emitter itself.

Specified by:

propagateVisitor in class Emitter

Parameters:

visitor - the visitor to invoke

Returns:

the resulting emitter returned by the visitor

visitExpressions

public void visitExpressions(Function<parsii.tokenizer.Position,ExpressionVisitor> visitorSupplier)

Description copied from class: Emitter

Visits all expressions contained in this emitter or its children.

Specified by:

visitExpressions in class Emitter

Parameters:

visitorSupplier - a function which generates an ExpressionVisitor while supplying the current position (for improved error messages).

append

public ConstantEmitter append(String stringToAppend)

Appends the given string to the output.

Parameters:

stringToAppend - the text to append

Returns:

the emitter itself for fluent method calls

emitToContext

protected void emitToContext(LocalRenderContext context)
                      throws Exception

Description copied from class: Emitter

Actually produces the output while relying on the caller to properly handle any exception.

Specified by:

emitToContext in class Emitter

Parameters:

context - the render context which provides access to the local and global environment and also the target for the generated text

Throws:

Exception - all thrown exceptions are caught and converted into a RenderException

toString

public String toString()

Overrides:

toString in class Object

getValue

public String getValue()

Returns the underlying text block which will be emitted.

Returns:

the text represented by this emitter