Package com.puppycrawl.tools.checkstyle

Class DetailAstImpl

java.lang.Object
antlr.BaseAST
antlr.CommonAST
antlr.CommonASTWithHiddenTokens
com.puppycrawl.tools.checkstyle.DetailAstImpl
All Implemented Interfaces:
antlr.collections.AST, DetailAST, Serializable
public final class DetailAstImpl extends antlr.CommonASTWithHiddenTokens implements DetailAST
The implementation of DetailAST. This should only be directly used to create custom AST nodes.
See Also:

  • Field Summary

    Fields inherited from class antlr.CommonASTWithHiddenTokens

    hiddenAfter, hiddenBefore

    Fields inherited from class antlr.BaseAST

    down, right

  • Constructor Summary

    Constructors
    Constructor
    Description
    DetailAstImpl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addChild(antlr.collections.AST ast)
     
    void
    addNextSibling(DetailAST ast)
    Add next sibling.
    void
    addPreviousSibling(DetailAST ast)
    Add previous sibling.
    boolean
    branchContains(int type)
    Checks if this branch of the parse tree contains a token of the provided type.
    DetailAST
    findFirstToken(int type)
    Returns the first child token that makes a specified type.
    int
    getChildCount()
    Returns the number of child nodes one level below this node.
    int
    getChildCount(int type)
    Returns the number of direct child tokens that have the specified type.
    int
    getColumnNo()
    Gets column number.
    DetailAstImpl
    getFirstChild()
    Get the first child of this AST.
    DetailAST
    getLastChild()
    Gets the last child node.
    int
    getLineNo()
    Gets line number.
    DetailAstImpl
    getNextSibling()
    Get the next sibling in line after this one.
    DetailAST
    getParent()
    Returns the parent token.
    DetailAST
    getPreviousSibling()
    Returns the previous sibling or null if no such sibling exists.
    boolean
    hasChildren()
    Returns whether this AST has any children.
    void
    initialize(antlr.collections.AST ast)
     
    void
    initialize(antlr.Token tok)
     
    void
    setColumnNo(int columnNo)
    Set column number.
    void
    setFirstChild(antlr.collections.AST ast)
     
    void
    setLineNo(int lineNo)
    Set line number.
    void
    setNextSibling(antlr.collections.AST ast)
     
    String
    toString()
     

    Methods inherited from class antlr.CommonASTWithHiddenTokens

    getHiddenAfter, getHiddenBefore

    Methods inherited from class antlr.CommonAST

    getText, getType, initialize, setText, setType

    Methods inherited from class antlr.BaseAST

    decode, encode, equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getColumn, getLine, getNumberOfChildren, getTokenNames, removeChildren, setVerboseStringConversion, toStringList, toStringTree, xmlSerialize, xmlSerializeNode, xmlSerializeRootClose, xmlSerializeRootOpen

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.puppycrawl.tools.checkstyle.api.DetailAST

    getNumberOfChildren, getText, getType

  • Constructor Details

    • DetailAstImpl

      public DetailAstImpl()

  • Method Details

    • initialize

      public void initialize(antlr.Token tok)
      Specified by:
      initialize in interface antlr.collections.AST
      Overrides:
      initialize in class antlr.CommonASTWithHiddenTokens

    • initialize

      public void initialize(antlr.collections.AST ast)
      Specified by:
      initialize in interface antlr.collections.AST
      Overrides:
      initialize in class antlr.CommonASTWithHiddenTokens

    • setFirstChild

      public void setFirstChild(antlr.collections.AST ast)
      Specified by:
      setFirstChild in interface antlr.collections.AST
      Overrides:
      setFirstChild in class antlr.BaseAST

    • setNextSibling

      public void setNextSibling(antlr.collections.AST ast)
      Specified by:
      setNextSibling in interface antlr.collections.AST
      Overrides:
      setNextSibling in class antlr.BaseAST

    • addPreviousSibling

      public void addPreviousSibling(DetailAST ast)
      Add previous sibling.
      Parameters:
      ast - DetailAST object.

    • addNextSibling

      public void addNextSibling(DetailAST ast)
      Add next sibling.
      Parameters:
      ast - DetailAST object.

    • addChild

      public void addChild(antlr.collections.AST ast)
      Specified by:
      addChild in interface antlr.collections.AST
      Overrides:
      addChild in class antlr.BaseAST

    • getChildCount

      public int getChildCount()
      Description copied from interface: DetailAST
      Returns the number of child nodes one level below this node. That is is does not recurse down the tree.
      Specified by:
      getChildCount in interface DetailAST
      Returns:
      the number of child nodes

    • getChildCount

      public int getChildCount(int type)
      Description copied from interface: DetailAST
      Returns the number of direct child tokens that have the specified type.
      Specified by:
      getChildCount in interface DetailAST
      Parameters:
      type - the token type to match
      Returns:
      the number of matching token

    • getParent

      public DetailAST getParent()
      Description copied from interface: DetailAST
      Returns the parent token.
      Specified by:
      getParent in interface DetailAST
      Returns:
      the parent token

    • getLineNo

      public int getLineNo()
      Description copied from interface: DetailAST
      Gets line number.
      Specified by:
      getLineNo in interface DetailAST
      Returns:
      the line number

    • setLineNo

      public void setLineNo(int lineNo)
      Set line number.
      Parameters:
      lineNo - line number.

    • getColumnNo

      public int getColumnNo()
      Description copied from interface: DetailAST
      Gets column number.
      Specified by:
      getColumnNo in interface DetailAST
      Returns:
      the column number

    • setColumnNo

      public void setColumnNo(int columnNo)
      Set column number.
      Parameters:
      columnNo - column number.

    • getLastChild

      public DetailAST getLastChild()
      Description copied from interface: DetailAST
      Gets the last child node.
      Specified by:
      getLastChild in interface DetailAST
      Returns:
      the last child node

    • branchContains

      public boolean branchContains(int type)
      Description copied from interface: DetailAST
      Checks if this branch of the parse tree contains a token of the provided type.
      Specified by:
      branchContains in interface DetailAST
      Parameters:
      type - a TokenType
      Returns:
      true if and only if this branch (including this node) contains a token of type type.

    • getPreviousSibling

      public DetailAST getPreviousSibling()
      Description copied from interface: DetailAST
      Returns the previous sibling or null if no such sibling exists.
      Specified by:
      getPreviousSibling in interface DetailAST
      Returns:
      the previous sibling or null if no such sibling exists.

    • findFirstToken

      public DetailAST findFirstToken(int type)
      Description copied from interface: DetailAST
      Returns the first child token that makes a specified type.
      Specified by:
      findFirstToken in interface DetailAST
      Parameters:
      type - the token type to match
      Returns:
      the matching token, or null if no match

    • toString

      public String toString()
      Specified by:
      toString in interface antlr.collections.AST
      Overrides:
      toString in class antlr.BaseAST

    • getNextSibling

      public DetailAstImpl getNextSibling()
      Description copied from interface: DetailAST
      Get the next sibling in line after this one.
      Specified by:
      getNextSibling in interface antlr.collections.AST
      Specified by:
      getNextSibling in interface DetailAST
      Overrides:
      getNextSibling in class antlr.BaseAST
      Returns:
      the next sibling or null if none.

    • getFirstChild

      public DetailAstImpl getFirstChild()
      Description copied from interface: DetailAST
      Get the first child of this AST.
      Specified by:
      getFirstChild in interface antlr.collections.AST
      Specified by:
      getFirstChild in interface DetailAST
      Overrides:
      getFirstChild in class antlr.BaseAST
      Returns:
      the first child or null if none.

    • hasChildren

      public boolean hasChildren()
      Description copied from interface: DetailAST
      Returns whether this AST has any children.
      Specified by:
      hasChildren in interface DetailAST
      Returns:
      true if this AST has any children.