sirius.tagliatelle.emitter

Class ExtraBlockEmitter

java.lang.Object

sirius.tagliatelle.emitter.Emitter

sirius.tagliatelle.emitter.ExtraBlockEmitter

public class ExtraBlockEmitter
extends Emitter

Emits the contents of an i:block defined at top-level into an extra block output of the context.

This permits to render several strings and sections within a single template.

See Also:

GlobalRenderContext.getExtraBlock(String)

Field Summary

Fields inherited from class sirius.tagliatelle.emitter.Emitter

startOfBlock

Constructor Summary

Constructors

Constructor and Description
ExtraBlockEmitter(String name, Emitter body) Creates a new instance with the given name and body.

Method Summary

Modifier and Type	Method and Description
Emitter	copy() Creates a deep copy of this emitter.
protected void	emitToContext(LocalRenderContext context) Actually produces the output while relying on the caller to properly handle any exception.
Emitter	propagateVisitor(EmitterVisitor visitor) Invokes the visitor on all sub emitters and on this emitter itself.
Emitter	reduce() Performs static optimizations at compile time.
void	visitExpressions(Function<parsii.tokenizer.Position,ExpressionVisitor> visitor) 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, toString, wait, wait, wait

Constructor Detail

ExtraBlockEmitter

public ExtraBlockEmitter(String name,
                         Emitter body)

Creates a new instance with the given name and body.

Parameters:

name - the name of the block

body - the body of the block

Method Detail

emitToContext

protected void emitToContext(@Nonnull
                             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

copy

@Nonnull
public Emitter copy()

Description copied from class: Emitter

Creates a deep copy of this emitter.

When templates are inlined, the parameters are propagated and constant expressions and conditions are evaluated at compile time. This yields faster and more efficient templates. In order to perform these optimizations, we need a copy of the template and all its emitters which can safely be modified.

Specified by:

copy in class Emitter

Returns:

a deep copy of this emitter, which can safely be modified without changing this emitter

reduce

@Nonnull
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

@Nonnull
public Emitter propagateVisitor(@Nonnull
                                         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(@Nonnull
                             Function<parsii.tokenizer.Position,ExpressionVisitor> visitor)

Description copied from class: Emitter

Visits all expressions contained in this emitter or its children.

Specified by:

visitExpressions in class Emitter

Parameters:

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