TreeWalker

All Known Implementing Classes:

BitmaskEmitter, ChoiceEmitter, CompatibilityChecker, ConstEmitter, DefaultTreeWalker, EnumerationEmitter, PubsubEmitter, ReservedKeywordsClashChecker, ServiceEmitter, SqlDatabaseEmitter, SqlTableEmitter, StructureEmitter, SubtypeEmitter, SubtypeEmitter, UnionEmitter
```
public interface TreeWalker
```
A TreeWalker is a class that walks main Zserio language entities. An TreeWalker is passed to walk method of Root node which traverses the AST and invokes methods of the TreeWalker when entering or leaving subtrees of the given type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`beginBitmask(BitmaskType bitmaskType)` Called when BitmaskType AST node begins.
`void`	`beginChoice(ChoiceType choiceType)` Called when ChoiceType AST node begins.
`void`	`beginConst(Constant constant)` Called when Constant AST node begins.
`void`	`beginEnumeration(EnumType enumType)` Called when EnumType AST node begins.
`void`	`beginImport(Import importNode)` Called when Import AST node begins.
`void`	`beginInstantiateType(InstantiateType instantiateType)` Called when InstantiateType AST node begins.
`void`	`beginPackage(Package pkg)` Called when Package AST node begins.
`void`	`beginPubsub(PubsubType pubsub)` Called when PubsubType AST node begins.
`void`	`beginRoot(Root root)` Called when Root AST node begins.
`void`	`beginRuleGroup(RuleGroup ruleGroup)` Called when RuleGroup AST node begins.
`void`	`beginService(ServiceType service)` Called when ServiceType AST node begins.
`void`	`beginSqlDatabase(SqlDatabaseType sqlDatabaseType)` Called when SqlDatabaseType AST node begins.
`void`	`beginSqlTable(SqlTableType sqlTableType)` Called when SqlTableType AST node begins.
`void`	`beginStructure(StructureType structureType)` Called when StructureType AST node begins.
`void`	`beginSubtype(Subtype subType)` Called when Subtype AST node begins.
`void`	`beginUnion(UnionType unionType)` Called when UnionType AST node begins.
`void`	`endPackage(Package pkg)` Called when Package node ends.
`void`	`endRoot(Root root)` Called when Root AST node ends.
`boolean`	`traverseTemplateInstantiations()` Returns whether to traverse template instantiations or just call appropriate TreeWalker's methods directly for templates.

- Method Detail
  - traverseTemplateInstantiations
```
boolean traverseTemplateInstantiations()
```
    Returns whether to traverse template instantiations or just call appropriate TreeWalker's methods directly for templates.
    
    Returns:
    
    True if the walker requests to traverse template instantiations, false otherwise.
  - beginRoot
```
void beginRoot(Root root)
        throws ZserioExtensionException
```
    Called when Root AST node begins.
    
    Parameters:
    
    root - Current Root AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - endRoot
```
void endRoot(Root root)
      throws ZserioExtensionException
```
    Called when Root AST node ends.
    
    Parameters:
    
    root - Current Root AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginPackage
```
void beginPackage(Package pkg)
           throws ZserioExtensionException
```
    Called when Package AST node begins.
    
    Parameters:
    
    pkg - Current Package AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - endPackage
```
void endPackage(Package pkg)
         throws ZserioExtensionException
```
    Called when Package node ends.
    
    Parameters:
    
    pkg - Current Package AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginImport
```
void beginImport(Import importNode)
          throws ZserioExtensionException
```
    Called when Import AST node begins.
    
    Parameters:
    
    importNode - Current Import AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginConst
```
void beginConst(Constant constant)
         throws ZserioExtensionException
```
    Called when Constant AST node begins.
    
    Parameters:
    
    constant - Current Constant AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginRuleGroup
```
void beginRuleGroup(RuleGroup ruleGroup)
             throws ZserioExtensionException
```
    Called when RuleGroup AST node begins.
    
    Parameters:
    
    ruleGroup - Current RuleGroup AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginSubtype
```
void beginSubtype(Subtype subType)
           throws ZserioExtensionException
```
    Called when Subtype AST node begins.
    
    Parameters:
    
    subType - Current Subtype AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginStructure
```
void beginStructure(StructureType structureType)
             throws ZserioExtensionException
```
    Called when StructureType AST node begins.
    
    Parameters:
    
    structureType - Current StructureType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginChoice
```
void beginChoice(ChoiceType choiceType)
          throws ZserioExtensionException
```
    Called when ChoiceType AST node begins.
    
    Parameters:
    
    choiceType - Current ChoiceType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginUnion
```
void beginUnion(UnionType unionType)
         throws ZserioExtensionException
```
    Called when UnionType AST node begins.
    
    Parameters:
    
    unionType - Current UnionType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginEnumeration
```
void beginEnumeration(EnumType enumType)
               throws ZserioExtensionException
```
    Called when EnumType AST node begins.
    
    Parameters:
    
    enumType - Current EnumType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginBitmask
```
void beginBitmask(BitmaskType bitmaskType)
           throws ZserioExtensionException
```
    Called when BitmaskType AST node begins.
    
    Parameters:
    
    bitmaskType - Current BitmaskType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginSqlTable
```
void beginSqlTable(SqlTableType sqlTableType)
            throws ZserioExtensionException
```
    Called when SqlTableType AST node begins.
    
    Parameters:
    
    sqlTableType - Current SqlTableType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginSqlDatabase
```
void beginSqlDatabase(SqlDatabaseType sqlDatabaseType)
               throws ZserioExtensionException
```
    Called when SqlDatabaseType AST node begins.
    
    Parameters:
    
    sqlDatabaseType - Current SqlDatabaseType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginService
```
void beginService(ServiceType service)
           throws ZserioExtensionException
```
    Called when ServiceType AST node begins.
    
    Parameters:
    
    service - Current ServiceType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginPubsub
```
void beginPubsub(PubsubType pubsub)
          throws ZserioExtensionException
```
    Called when PubsubType AST node begins.
    
    Parameters:
    
    pubsub - Current PubsubType AST node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.
  - beginInstantiateType
```
void beginInstantiateType(InstantiateType instantiateType)
                   throws ZserioExtensionException
```
    Called when InstantiateType AST node begins.
    
    Parameters:
    
    instantiateType - Current InstantiateType node.
    
    Throws:
    
    ZserioExtensionException - In case of any internal error of the extension.

Interface TreeWalker

Method Summary

Method Detail

traverseTemplateInstantiations

beginRoot

endRoot

beginPackage

endPackage

beginImport

beginConst

beginRuleGroup

beginSubtype

beginStructure

beginChoice

beginUnion

beginEnumeration

beginBitmask

beginSqlTable

beginSqlDatabase

beginService

beginPubsub

beginInstantiateType