Visitors.DispatchIrVisitor (golo 3.4.0 API)

java.lang.Object
- gololang.ir.Visitors.DispatchIrVisitor

All Implemented Interfaces:

GoloIrVisitor, java.util.function.BiFunction<java.lang.Object,GoloElement<?>,java.lang.Object>

Enclosing class:

Visitors
```
public abstract static class Visitors.DispatchIrVisitor
extends java.lang.Object
implements GoloIrVisitor, java.util.function.BiFunction<java.lang.Object,GoloElement<?>,java.lang.Object>
```
A special adapter class to ease the creation of IR visitors in Golo.
The visitor will apply a given function to elements in the IR tree, accumulating returned values.
Three kinds of functions are valid:
- unary functions will be called with the current element only, the returned value is stored in the accumulator;
- binary functions will be called with the current accumulator and the current element, the returned value is stored in the accumulator; this is the more natural version, similar to a reduce;
- ternary functions will be called with the visitor itself, the accumulator, and the current element, the returned value is stored in the accumulator if not null.
This last version is more complicated, but gives full access to the user on how to walk the tree and change the accumulator.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`accumulator()`
`Visitors.DispatchIrVisitor`	`accumulator(java.lang.Object acc)` Initialize the accumulator.
`java.lang.Object`	`apply(java.lang.Object acc, GoloElement<?> elt)` Function-like use of the visitor.
`protected abstract FunctionReference`	`dispatchFunction(GoloElement<?> elt)`
`void`	`visitAssignmentStatement(AssignmentStatement elt)`
`void`	`visitAugmentation(Augmentation elt)`
`void`	`visitBinaryOperation(BinaryOperation elt)`
`void`	`visitBlock(Block elt)`
`void`	`visitCaseStatement(CaseStatement elt)`
`void`	`visitClosureReference(ClosureReference elt)`
`void`	`visitCollectionComprehension(CollectionComprehension elt)`
`void`	`visitCollectionLiteral(CollectionLiteral elt)`
`void`	`visitConditionalBranching(ConditionalBranching elt)`
`void`	`visitConstantStatement(ConstantStatement elt)`
`void`	`visitDecorator(Decorator elt)`
`void`	`visitDestructuringAssignment(DestructuringAssignment elt)`
`void`	`visitForEachLoopStatement(ForEachLoopStatement elt)`
`void`	`visitFunction(GoloFunction elt)`
`void`	`visitFunctionInvocation(FunctionInvocation elt)`
`void`	`visitLocalReference(LocalReference elt)`
`void`	`visitLoopBreakFlowStatement(LoopBreakFlowStatement elt)`
`void`	`visitLoopStatement(LoopStatement elt)`
`void`	`visitMacroInvocation(MacroInvocation elt)`
`void`	`visitMatchExpression(MatchExpression elt)`
`void`	`visitMember(Member elt)`
`void`	`visitMethodInvocation(MethodInvocation elt)`
`void`	`visitModule(GoloModule elt)`
`void`	`visitModuleImport(ModuleImport elt)`
`void`	`visitNamedArgument(NamedArgument elt)`
`void`	`visitNamedAugmentation(NamedAugmentation elt)`
`void`	`visitNoop(Noop elt)`
`void`	`visitReferenceLookup(ReferenceLookup elt)`
`void`	`visitReturnStatement(ReturnStatement elt)`
`void`	`visitStruct(Struct elt)`
`void`	`visitThrowStatement(ThrowStatement elt)`
`void`	`visitToplevelElements(ToplevelElements elt)`
`void`	`visitTryCatchFinally(TryCatchFinally elt)`
`void`	`visitUnaryOperation(UnaryOperation elt)`
`void`	`visitUnion(Union elt)`
`void`	`visitUnionValue(UnionValue elt)`
`void`	`visitWhenClause(WhenClause<?> elt)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.BiFunction
andThen

- Method Detail
  - dispatchFunction
```
protected abstract FunctionReference dispatchFunction(GoloElement<?> elt)
```
  - accumulator
```
public java.lang.Object accumulator()
```
    Returns:
    
    the value of the accumulator.
  - accumulator
```
public Visitors.DispatchIrVisitor accumulator(java.lang.Object acc)
```
    Initialize the accumulator.
  - apply
```
public java.lang.Object apply(java.lang.Object acc,
                              GoloElement<?> elt)
```
    Function-like use of the visitor.
    Initialize the accumulator with the given value, visit the given element, and returns the final value of the accumulator.
    
    Specified by:
    
    apply in interface java.util.function.BiFunction<java.lang.Object,GoloElement<?>,java.lang.Object>
    
    Parameters:
    
    acc - the initial value for the accumulator
    
    elt - the IR element to visit
    
    Returns:
    
    the final value of the accumulator
  - visitModule
```
public void visitModule(GoloModule elt)
```
    Specified by:
    
    visitModule in interface GoloIrVisitor
  - visitModuleImport
```
public void visitModuleImport(ModuleImport elt)
```
    Specified by:
    
    visitModuleImport in interface GoloIrVisitor
  - visitStruct
```
public void visitStruct(Struct elt)
```
    Specified by:
    
    visitStruct in interface GoloIrVisitor
  - visitUnion
```
public void visitUnion(Union elt)
```
    Specified by:
    
    visitUnion in interface GoloIrVisitor
  - visitUnionValue
```
public void visitUnionValue(UnionValue elt)
```
    Specified by:
    
    visitUnionValue in interface GoloIrVisitor
  - visitAugmentation
```
public void visitAugmentation(Augmentation elt)
```
    Specified by:
    
    visitAugmentation in interface GoloIrVisitor
  - visitNamedAugmentation
```
public void visitNamedAugmentation(NamedAugmentation elt)
```
    Specified by:
    
    visitNamedAugmentation in interface GoloIrVisitor
  - visitFunction
```
public void visitFunction(GoloFunction elt)
```
    Specified by:
    
    visitFunction in interface GoloIrVisitor
  - visitDecorator
```
public void visitDecorator(Decorator elt)
```
    Specified by:
    
    visitDecorator in interface GoloIrVisitor
  - visitBlock
```
public void visitBlock(Block elt)
```
    Specified by:
    
    visitBlock in interface GoloIrVisitor
  - visitConstantStatement
```
public void visitConstantStatement(ConstantStatement elt)
```
    Specified by:
    
    visitConstantStatement in interface GoloIrVisitor
  - visitReturnStatement
```
public void visitReturnStatement(ReturnStatement elt)
```
    Specified by:
    
    visitReturnStatement in interface GoloIrVisitor
  - visitFunctionInvocation
```
public void visitFunctionInvocation(FunctionInvocation elt)
```
    Specified by:
    
    visitFunctionInvocation in interface GoloIrVisitor
  - visitMethodInvocation
```
public void visitMethodInvocation(MethodInvocation elt)
```
    Specified by:
    
    visitMethodInvocation in interface GoloIrVisitor
  - visitAssignmentStatement
```
public void visitAssignmentStatement(AssignmentStatement elt)
```
    Specified by:
    
    visitAssignmentStatement in interface GoloIrVisitor
  - visitDestructuringAssignment
```
public void visitDestructuringAssignment(DestructuringAssignment elt)
```
    Specified by:
    
    visitDestructuringAssignment in interface GoloIrVisitor
  - visitReferenceLookup
```
public void visitReferenceLookup(ReferenceLookup elt)
```
    Specified by:
    
    visitReferenceLookup in interface GoloIrVisitor
  - visitConditionalBranching
```
public void visitConditionalBranching(ConditionalBranching elt)
```
    Specified by:
    
    visitConditionalBranching in interface GoloIrVisitor
  - visitBinaryOperation
```
public void visitBinaryOperation(BinaryOperation elt)
```
    Specified by:
    
    visitBinaryOperation in interface GoloIrVisitor
  - visitUnaryOperation
```
public void visitUnaryOperation(UnaryOperation elt)
```
    Specified by:
    
    visitUnaryOperation in interface GoloIrVisitor
  - visitLoopStatement
```
public void visitLoopStatement(LoopStatement elt)
```
    Specified by:
    
    visitLoopStatement in interface GoloIrVisitor
  - visitForEachLoopStatement
```
public void visitForEachLoopStatement(ForEachLoopStatement elt)
```
    Specified by:
    
    visitForEachLoopStatement in interface GoloIrVisitor
  - visitCaseStatement
```
public void visitCaseStatement(CaseStatement elt)
```
    Specified by:
    
    visitCaseStatement in interface GoloIrVisitor
  - visitMatchExpression
```
public void visitMatchExpression(MatchExpression elt)
```
    Specified by:
    
    visitMatchExpression in interface GoloIrVisitor
  - visitWhenClause
```
public void visitWhenClause(WhenClause<?> elt)
```
    Specified by:
    
    visitWhenClause in interface GoloIrVisitor
  - visitThrowStatement
```
public void visitThrowStatement(ThrowStatement elt)
```
    Specified by:
    
    visitThrowStatement in interface GoloIrVisitor
  - visitTryCatchFinally
```
public void visitTryCatchFinally(TryCatchFinally elt)
```
    Specified by:
    
    visitTryCatchFinally in interface GoloIrVisitor
  - visitClosureReference
```
public void visitClosureReference(ClosureReference elt)
```
    Specified by:
    
    visitClosureReference in interface GoloIrVisitor
  - visitLoopBreakFlowStatement
```
public void visitLoopBreakFlowStatement(LoopBreakFlowStatement elt)
```
    Specified by:
    
    visitLoopBreakFlowStatement in interface GoloIrVisitor
  - visitCollectionLiteral
```
public void visitCollectionLiteral(CollectionLiteral elt)
```
    Specified by:
    
    visitCollectionLiteral in interface GoloIrVisitor
  - visitCollectionComprehension
```
public void visitCollectionComprehension(CollectionComprehension elt)
```
    Specified by:
    
    visitCollectionComprehension in interface GoloIrVisitor
  - visitNamedArgument
```
public void visitNamedArgument(NamedArgument elt)
```
    Specified by:
    
    visitNamedArgument in interface GoloIrVisitor
  - visitLocalReference
```
public void visitLocalReference(LocalReference elt)
```
    Specified by:
    
    visitLocalReference in interface GoloIrVisitor
  - visitMember
```
public void visitMember(Member elt)
```
    Specified by:
    
    visitMember in interface GoloIrVisitor
  - visitMacroInvocation
```
public void visitMacroInvocation(MacroInvocation elt)
```
    Specified by:
    
    visitMacroInvocation in interface GoloIrVisitor
  - visitNoop
```
public void visitNoop(Noop elt)
```
    Specified by:
    
    visitNoop in interface GoloIrVisitor
  - visitToplevelElements
```
public void visitToplevelElements(ToplevelElements elt)
```
    Specified by:
    
    visitToplevelElements in interface GoloIrVisitor

Class Visitors.DispatchIrVisitor

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.BiFunction

Method Detail

dispatchFunction

accumulator

accumulator

apply

visitModule

visitModuleImport

visitStruct

visitUnion

visitUnionValue

visitAugmentation

visitNamedAugmentation

visitFunction

visitDecorator

visitBlock

visitConstantStatement

visitReturnStatement

visitFunctionInvocation

visitMethodInvocation

visitAssignmentStatement

visitDestructuringAssignment

visitReferenceLookup

visitConditionalBranching

visitBinaryOperation

visitUnaryOperation

visitLoopStatement

visitForEachLoopStatement

visitCaseStatement

visitMatchExpression

visitWhenClause

visitThrowStatement

visitTryCatchFinally

visitClosureReference

visitLoopBreakFlowStatement

visitCollectionLiteral

visitCollectionComprehension

visitNamedArgument

visitLocalReference

visitMember

visitMacroInvocation

visitNoop

visitToplevelElements