LoopEmitter (SIRIUS web 19.0-rc8 API)

java.lang.Object
- sirius.tagliatelle.emitter.Emitter
- - sirius.tagliatelle.emitter.LoopEmitter

```
public class LoopEmitter
extends Emitter
```
Loops over a given Iterable and invokes the given block for each item within.

Field Summary
- Fields inherited from class sirius.tagliatelle.emitter.Emitter
  startOfBlock

Constructor Summary

Constructors
Constructor and Description

LoopEmitter(parsii.tokenizer.Position startOfBlock)
Creates a new emitter for the given position.

Constructors
Constructor and Description
`LoopEmitter(parsii.tokenizer.Position startOfBlock)` Creates a new emitter for the given position.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`Expression`	`getIterableExpression()` Returns the expression which yields the items to iterate through.
`int`	`getLocalIndex()` Contains the stack index being written to.
`int`	`getLoopStateIndex()` Contains the stack index which contains the loop state or -1 to indicate that the loop state is unused.
`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`	`setIterableExpression(Expression iterableExpression)` Specifies the expression to evaluate which yields the items to iterate over.
`void`	`setLocalIndex(int localIndex)` Updates the stack index being written to.
`void`	`setLoop(Emitter loop)` Sets the body to emit once per item in the list of items to output.
`void`	`setLoopStateIndex(int loopStateIndex)` Updates the stack index of the loop state.
`String`	`toString()`
`void`	`verify(CompilationContext compilationContext)` Verifies the consistency of the emitter.
`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

- Constructor Detail
  - LoopEmitter
```
public LoopEmitter(parsii.tokenizer.Position startOfBlock)
```
    Creates a new emitter for the given position.
    
    Parameters:
    
    startOfBlock - the position where the emitter was declared.
- Method Detail
  - setIterableExpression
```
public void setIterableExpression(Expression iterableExpression)
```
    Specifies the expression to evaluate which yields the items to iterate over.
    
    Parameters:
    
    iterableExpression - the expression which evaluates to the list of items to process
  - setLoop
```
public void setLoop(Emitter loop)
```
    Sets the body to emit once per item in the list of items to output.
    
    Parameters:
    
    loop - the loop body to emit per item
  - copy
```
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
```
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
  - verify
```
public void verify(CompilationContext compilationContext)
```
    Verifies the consistency of the emitter.
    
    Parameters:
    
    compilationContext - the context used to report errors to
  - 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).
  - 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
  - getIterableExpression
```
public Expression getIterableExpression()
```
    Returns the expression which yields the items to iterate through.
    
    Returns:
    
    the expression to iterate through
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setLoopStateIndex
```
public void setLoopStateIndex(int loopStateIndex)
```
    Updates the stack index of the loop state.
    When inlining a template, the stack has to be transferred to the callee and therefore the stack indices might change.
    
    Parameters:
    
    loopStateIndex - the new stack index to use
  - getLoopStateIndex
```
public int getLoopStateIndex()
```
    Contains the stack index which contains the loop state or -1 to indicate that the loop state is unused.
    
    Returns:
    
    the target index for the loop state
  - getLocalIndex
```
public int getLocalIndex()
```
    Contains the stack index being written to.
    
    Returns:
    
    the target index to write to
  - setLocalIndex
```
public void setLocalIndex(int localIndex)
```
    Updates the stack index being written to.
    When inlining a template, the stack has to be transferred to the callee and therefore the stack indices might change.
    
    Parameters:
    
    localIndex - the new stack index to use

Class LoopEmitter

Field Summary

Fields inherited from class sirius.tagliatelle.emitter.Emitter

Constructor Summary

Method Summary

Methods inherited from class sirius.tagliatelle.emitter.Emitter

Methods inherited from class java.lang.Object

Constructor Detail

LoopEmitter

Method Detail

setIterableExpression

setLoop

copy

reduce

verify

propagateVisitor

visitExpressions

emitToContext

getIterableExpression

toString

setLoopStateIndex

getLoopStateIndex

getLocalIndex

setLocalIndex