Package com.puppycrawl.tools.checkstyle

Class JavaParser

java.lang.Object
com.puppycrawl.tools.checkstyle.JavaParser
public final class JavaParser extends Object
Helper methods to parse java source files.

  • Method Details

    • parse

      public static DetailAST parse(FileContents contents) throws CheckstyleException
      Static helper method to parses a Java source file.
      Parameters:
      contents - contains the contents of the file
      Returns:
      the root of the AST
      Throws:
      CheckstyleException - if the contents is not a valid Java source

    • parseFileText

      public static DetailAST parseFileText(FileText text, JavaParser.Options options) throws CheckstyleException
      Parse a text and return the parse tree.
      Parameters:
      text - the text to parse
      options - JavaParser.Options to control inclusion of comment nodes
      Returns:
      the root node of the parse tree
      Throws:
      CheckstyleException - if the text is not a valid Java source

    • parseFile

      public static DetailAST parseFile(File file, JavaParser.Options options) throws IOException, CheckstyleException
      Parses Java source file.
      Parameters:
      file - the file to parse
      options - JavaParser.Options to control inclusion of comment nodes
      Returns:
      DetailAST tree
      Throws:
      IOException - if the file could not be read
      CheckstyleException - if the file is not a valid Java source file

    • appendHiddenCommentNodes

      public static DetailAST appendHiddenCommentNodes(DetailAST root)
      Appends comment nodes to existing AST. It traverses each node in AST, looks for hidden comment tokens and appends found comment tokens as nodes in AST.
      Parameters:
      root - of AST
      Returns:
      root of AST with comment nodes