JavaParser (javaparser-core 3.0.0-alpha.1 API)

java.lang.Object
- com.github.javaparser.JavaParser

```
public final class JavaParser
extends Object
```
Parse Java source code and creates Abstract Syntax Tree classes.

Author:

Júlio Vilmar Gesser

Constructor Summary

Constructors
Constructor and Description

JavaParser()
Instantiate the parser.

Constructors
Constructor and Description
`JavaParser()` Instantiate the parser.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`getDoNotAssignCommentsPreceedingEmptyLines()`
`static boolean`	`getDoNotConsiderAnnotationsAsNodeStartForCodeAttribution()`
`List<Token>`	`getTokens()` Return the list of tokens that have been encountered while parsing code using this parser.
`CompilationUnit`	`parse()` Parses the Java code and returns a `CompilationUnit` that represents it.
`static CompilationUnit`	`parse(File file)` Parses the Java code contained in a `File` and returns a `CompilationUnit` that represents it. Note: Uses UTF-8 encoding
`static CompilationUnit`	`parse(File file, Charset encoding)`
`static CompilationUnit`	`parse(File file, Charset encoding, boolean considerComments)` Parses the Java code contained in a `File` and returns a `CompilationUnit` that represents it.
`static CompilationUnit`	`parse(InputStream in)` Parses the Java code contained in the `InputStream` and returns a `CompilationUnit` that represents it. Note: Uses UTF-8 encoding
`static CompilationUnit`	`parse(InputStream in, Charset encoding)`
`static CompilationUnit`	`parse(InputStream in, Charset encoding, boolean considerComments)` Parses the Java code contained in the `InputStream` and returns a `CompilationUnit` that represents it.
`static CompilationUnit`	`parse(Reader reader)`
`static CompilationUnit`	`parse(Reader reader, boolean considerComments)`
`static CompilationUnit`	`parse(String code)` Parses the Java code contained in code and returns a `CompilationUnit` that represents it.
`static CompilationUnit`	`parse(String code, boolean considerComments)` Parses the Java code contained in code and returns a `CompilationUnit` that represents it.
`AnnotationExpr`	`parseAnnotation()` Parses the Java annotation and returns a `AnnotationExpr` that represents it.
`static AnnotationExpr`	`parseAnnotation(String annotation)` Parses the Java annotation contained in a `String` and returns a `AnnotationExpr` that represents it.
`BlockStmt`	`parseBlock()` Parses the Java block and returns a `BlockStmt` that represents it.
`static BlockStmt`	`parseBlock(String blockStatement)` Parses the Java block contained in a `String` and returns a `BlockStmt` that represents it.
`BodyDeclaration<?>`	`parseBodyDeclaration()` Parses the Java body declaration(e.g fields or methods) and returns a `BodyDeclaration` that represents it.
`static BodyDeclaration<?>`	`parseBodyDeclaration(String body)` Parses the Java body declaration(e.g fields or methods) contained in a `String` and returns a `BodyDeclaration` that represents it.
`BodyDeclaration<?>`	`parseClassBodyDeclaration()` Parses a Java class body declaration(e.g fields or methods) and returns a `BodyDeclaration` that represents it.
`static BodyDeclaration<?>`	`parseClassBodyDeclaration(String body)` Parses a Java class body declaration(e.g fields or methods) and returns a `BodyDeclaration` that represents it.
`Expression`	`parseExpression()` Parses the Java expression and returns a `Expression` that represents it.
`static Expression`	`parseExpression(String expression)` Parses the Java expression contained in a `String` and returns a `Expression` that represents it.
`ImportDeclaration`	`parseImport()` Parses the Java import and returns a `ImportDeclaration` that represents it.
`static ImportDeclaration`	`parseImport(String importDeclaration)` Parses the Java import contained in a `String` and returns a `ImportDeclaration` that represents it.
`BodyDeclaration<?>`	`parseInterfaceBodyDeclaration()` Parses a Java interface body declaration(e.g fields or methods) and returns a `BodyDeclaration` that represents it.
`static BodyDeclaration`	`parseInterfaceBodyDeclaration(String body)` Parses a Java interface body declaration(e.g fields or methods) and returns a `BodyDeclaration` that represents it.
`Statement`	`parseStatement()` Parses the Java statement and returns a `Statement` that represents it.
`static Statement`	`parseStatement(String statement)` Parses the Java statement contained in a `String` and returns a `Statement` that represents it.
`List<Statement>`	`parseStatements()` Parses the Java block and returns a `List` of `Statement`s that represents it.
`static List<Statement>`	`parseStatements(String statements)` Parses the Java statements contained in a `String` and returns a list of `Statement` that represents it.
`static void`	`setDoNotAssignCommentsPreceedingEmptyLines(boolean newValue)`
`static void`	`setDoNotConsiderAnnotationsAsNodeStartForCodeAttribution(boolean newValue)`
`JavaParser`	`setSource(File file)`
`JavaParser`	`setSource(File file, Charset encoding)`
`JavaParser`	`setSource(InputStream input)`
`JavaParser`	`setSource(InputStream input, Charset encoding)`
`JavaParser`	`setSource(Provider provider)`
`JavaParser`	`setSource(Reader reader)`
`JavaParser`	`setSource(String source)`

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

- Constructor Detail
  - JavaParser
```
public JavaParser()
```
    Instantiate the parser. Note that parsing can also be done with the static methods on this class. Creating an instance will reduce setup time between parsing files.
- Method Detail
  - setSource
```
public JavaParser setSource(Provider provider)
```
  - setSource
```
public JavaParser setSource(Reader reader)
```
  - setSource
```
public JavaParser setSource(InputStream input)
                     throws IOException
```
    Throws:
    
    IOException
  - setSource
```
public JavaParser setSource(InputStream input,
                            Charset encoding)
                     throws IOException
```
    Throws:
    
    IOException
  - setSource
```
public JavaParser setSource(File file)
                     throws IOException
```
    Throws:
    
    IOException
  - setSource
```
public JavaParser setSource(File file,
                            Charset encoding)
                     throws IOException
```
    Throws:
    
    IOException
  - setSource
```
public JavaParser setSource(String source)
```
  - getTokens
```
public List<Token> getTokens()
```
    Return the list of tokens that have been encountered while parsing code using this parser.
    
    Returns:
    
    a list of tokens
  - parse
```
public CompilationUnit parse()
                      throws ParseException
```
    Parses the Java code and returns a CompilationUnit that represents it.
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseBlock
```
public BlockStmt parseBlock()
                     throws ParseException
```
    Parses the Java block and returns a BlockStmt that represents it.
    
    Returns:
    
    BlockStmt representing the Java block
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseStatements
```
public List<Statement> parseStatements()
                                throws ParseException
```
    Parses the Java block and returns a List of Statements that represents it.
    
    Returns:
    
    Statement representing the Java statement
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseStatement
```
public Statement parseStatement()
                         throws ParseException
```
    Parses the Java statement and returns a Statement that represents it.
    
    Returns:
    
    Statement representing the Java statement
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseImport
```
public ImportDeclaration parseImport()
                              throws ParseException
```
    Parses the Java import and returns a ImportDeclaration that represents it.
    
    Returns:
    
    ImportDeclaration representing the Java import declaration
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseExpression
```
public Expression parseExpression()
                           throws ParseException
```
    Parses the Java expression and returns a Expression that represents it.
    
    Returns:
    
    Expression representing the Java expression
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseAnnotation
```
public AnnotationExpr parseAnnotation()
                               throws ParseException
```
    Parses the Java annotation and returns a AnnotationExpr that represents it.
    
    Returns:
    
    AnnotationExpr representing the Java annotation
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseBodyDeclaration
```
public BodyDeclaration<?> parseBodyDeclaration()
                                        throws ParseException
```
    Parses the Java body declaration(e.g fields or methods) and returns a BodyDeclaration that represents it.
    
    Returns:
    
    BodyDeclaration representing the Java body
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseClassBodyDeclaration
```
public BodyDeclaration<?> parseClassBodyDeclaration()
                                             throws ParseException
```
    Parses a Java class body declaration(e.g fields or methods) and returns a BodyDeclaration that represents it.
    
    Returns:
    
    BodyDeclaration representing the Java class body
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseInterfaceBodyDeclaration
```
public BodyDeclaration<?> parseInterfaceBodyDeclaration()
                                                 throws ParseException
```
    Parses a Java interface body declaration(e.g fields or methods) and returns a BodyDeclaration that represents it.
    
    Returns:
    
    BodyDeclaration representing the Java interface body
    
    Throws:
    
    ParseException - if the source code has parser errors
  - getDoNotConsiderAnnotationsAsNodeStartForCodeAttribution
```
public static boolean getDoNotConsiderAnnotationsAsNodeStartForCodeAttribution()
```
  - setDoNotConsiderAnnotationsAsNodeStartForCodeAttribution
```
public static void setDoNotConsiderAnnotationsAsNodeStartForCodeAttribution(boolean newValue)
```
  - getDoNotAssignCommentsPreceedingEmptyLines
```
public static boolean getDoNotAssignCommentsPreceedingEmptyLines()
```
  - setDoNotAssignCommentsPreceedingEmptyLines
```
public static void setDoNotAssignCommentsPreceedingEmptyLines(boolean newValue)
```
  - parse
```
public static CompilationUnit parse(InputStream in,
                                    Charset encoding)
                             throws ParseException
```
    Throws:
    
    ParseException
  - parse
```
public static CompilationUnit parse(InputStream in,
                                    Charset encoding,
                                    boolean considerComments)
                             throws ParseException
```
    Parses the Java code contained in the InputStream and returns a CompilationUnit that represents it.
    
    Parameters:
    
    in - InputStream containing Java source code
    
    encoding - encoding of the source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parse
```
public static CompilationUnit parse(InputStream in)
                             throws ParseException
```
    Parses the Java code contained in the InputStream and returns a CompilationUnit that represents it.
    Note: Uses UTF-8 encoding
    
    Parameters:
    
    in - InputStream containing Java source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parse
```
public static CompilationUnit parse(File file,
                                    Charset encoding)
                             throws ParseException,
                                    IOException
```
    Throws:
    
    ParseException
    
    IOException
  - parse
```
public static CompilationUnit parse(File file,
                                    Charset encoding,
                                    boolean considerComments)
                             throws ParseException
```
    Parses the Java code contained in a File and returns a CompilationUnit that represents it.
    
    Parameters:
    
    file - File containing Java source code
    
    encoding - encoding of the source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parse
```
public static CompilationUnit parse(File file)
                             throws ParseException,
                                    IOException
```
    Parses the Java code contained in a File and returns a CompilationUnit that represents it.
    Note: Uses UTF-8 encoding
    
    Parameters:
    
    file - File containing Java source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseException - if the source code has parser errors
    
    IOException
  - parse
```
public static CompilationUnit parse(Reader reader)
                             throws ParseException
```
    Throws:
    
    ParseException
  - parse
```
public static CompilationUnit parse(Reader reader,
                                    boolean considerComments)
                             throws ParseException
```
    Throws:
    
    ParseException
  - parse
```
public static CompilationUnit parse(String code,
                                    boolean considerComments)
                             throws ParseException
```
    Parses the Java code contained in code and returns a CompilationUnit that represents it.
    
    Parameters:
    
    code - Java source code
    
    considerComments - parse or ignore comments
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parse
```
public static CompilationUnit parse(String code)
                             throws ParseException
```
    Parses the Java code contained in code and returns a CompilationUnit that represents it.
    
    Parameters:
    
    code - Java source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseBlock
```
public static BlockStmt parseBlock(String blockStatement)
                            throws ParseException
```
    Parses the Java block contained in a String and returns a BlockStmt that represents it.
    
    Parameters:
    
    blockStatement - String containing Java block code
    
    Returns:
    
    BlockStmt representing the Java block
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseStatement
```
public static Statement parseStatement(String statement)
                                throws ParseException
```
    Parses the Java statement contained in a String and returns a Statement that represents it.
    
    Parameters:
    
    statement - String containing Java statement code
    
    Returns:
    
    Statement representing the Java statement
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseStatements
```
public static List<Statement> parseStatements(String statements)
                                       throws ParseException
```
    Parses the Java statements contained in a String and returns a list of Statement that represents it.
    
    Parameters:
    
    statements - String containing Java statements
    
    Returns:
    
    list of Statement representing the Java statement
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseImport
```
public static ImportDeclaration parseImport(String importDeclaration)
                                     throws ParseException
```
    Parses the Java import contained in a String and returns a ImportDeclaration that represents it.
    
    Parameters:
    
    importDeclaration - String containing Java import code
    
    Returns:
    
    ImportDeclaration representing the Java import declaration
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseExpression
```
public static Expression parseExpression(String expression)
                                  throws ParseException
```
    Parses the Java expression contained in a String and returns a Expression that represents it.
    
    Parameters:
    
    expression - String containing Java expression
    
    Returns:
    
    Expression representing the Java expression
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseAnnotation
```
public static AnnotationExpr parseAnnotation(String annotation)
                                      throws ParseException
```
    Parses the Java annotation contained in a String and returns a AnnotationExpr that represents it.
    
    Parameters:
    
    annotation - String containing Java annotation
    
    Returns:
    
    AnnotationExpr representing the Java annotation
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseBodyDeclaration
```
public static BodyDeclaration<?> parseBodyDeclaration(String body)
                                               throws ParseException
```
    Parses the Java body declaration(e.g fields or methods) contained in a String and returns a BodyDeclaration that represents it.
    
    Parameters:
    
    body - String containing Java body declaration
    
    Returns:
    
    BodyDeclaration representing the Java annotation
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseClassBodyDeclaration
```
public static BodyDeclaration<?> parseClassBodyDeclaration(String body)
                                                    throws ParseException
```
    Parses a Java class body declaration(e.g fields or methods) and returns a BodyDeclaration that represents it.
    
    Parameters:
    
    body - the body of a class
    
    Returns:
    
    BodyDeclaration representing the Java class body
    
    Throws:
    
    ParseException - if the source code has parser errors
  - parseInterfaceBodyDeclaration
```
public static BodyDeclaration parseInterfaceBodyDeclaration(String body)
                                                     throws ParseException
```
    Parses a Java interface body declaration(e.g fields or methods) and returns a BodyDeclaration that represents it.
    
    Parameters:
    
    body - the body of an interface
    
    Returns:
    
    BodyDeclaration representing the Java interface body
    
    Throws:
    
    ParseException - if the source code has parser errors

Class JavaParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JavaParser

Method Detail

setSource

setSource

setSource

setSource

setSource

setSource

setSource

getTokens

parse

parseBlock

parseStatements

parseStatement

parseImport

parseExpression

parseAnnotation

parseBodyDeclaration

parseClassBodyDeclaration

parseInterfaceBodyDeclaration

getDoNotConsiderAnnotationsAsNodeStartForCodeAttribution

setDoNotConsiderAnnotationsAsNodeStartForCodeAttribution

getDoNotAssignCommentsPreceedingEmptyLines

setDoNotAssignCommentsPreceedingEmptyLines

parse

parse

parse

parse

parse

parse

parse

parse

parse

parse

parseBlock

parseStatement

parseStatements

parseImport

parseExpression

parseAnnotation

parseBodyDeclaration

parseClassBodyDeclaration

parseInterfaceBodyDeclaration