Class StmtsDoc

  • All Implemented Interfaces:
    Tagged, java.lang.Iterable<StmtsBlock>

    public class StmtsDoc
    extends java.lang.Object
    implements Tagged, java.lang.Iterable<StmtsBlock>
    StmtsDoc creates a logical view of a statements doc that includes all inherited and overridden values for bindings, tags, and params.
    • Constructor Summary

      Constructors 
      Constructor Description
      StmtsDoc​(RawStmtsDoc rawStmtsDoc)  
    • Method Summary

      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> getBindings()  
      java.util.List<StmtsBlock> getBlocks()  
      java.lang.String getName()  
      java.util.Map<java.lang.String,​java.lang.String> getParams()  
      java.util.List<StmtDef> getStmts()  
      java.util.Map<java.lang.String,​java.lang.String> getTags()  
      java.util.Iterator<StmtsBlock> iterator()
      Allow StmtsDoc to be used in iterable loops.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Constructor Detail

      • StmtsDoc

        public StmtsDoc​(RawStmtsDoc rawStmtsDoc)
    • Method Detail

      • getBlocks

        public java.util.List<StmtsBlock> getBlocks()
        Returns:
        a usable list of blocks, including inherited bindings, params, and tags from the parent doc
      • getTags

        public java.util.Map<java.lang.String,​java.lang.String> getTags()
        Specified by:
        getTags in interface Tagged
        Returns:
        a usable map of tags, including those inherited from the parent doc
      • getParams

        public java.util.Map<java.lang.String,​java.lang.String> getParams()
        Returns:
        a usable map of parameters, including those inherited from the parent doc
      • getBindings

        public java.util.Map<java.lang.String,​java.lang.String> getBindings()
        Returns:
        a usable map of bindings, including those inherited from the parent doc
      • getName

        public java.lang.String getName()
        Returns:
        the name of this block
      • getStmts

        public java.util.List<StmtDef> getStmts()
        Returns:
        The list of all included statements for all included block in this document, including the inherited and overridden values from the this doc and the parent block.
      • iterator

        public java.util.Iterator<StmtsBlock> iterator()
        Allow StmtsDoc to be used in iterable loops.
        Specified by:
        iterator in interface java.lang.Iterable<StmtsBlock>
        Returns:
        An iterator of StmtsBlock