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

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

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

Author:

Júlio Vilmar Gesser

Constructor Summary

Constructors
Constructor and Description

JavaParser(ParserConfiguration configuration)
Instantiate the parser.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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(Path path)` Parses the Java code contained in a file and returns a `CompilationUnit` that represents it. Note: Uses UTF-8 encoding
`static CompilationUnit`	`parse(Path path, Charset encoding)`
`static CompilationUnit`	`parse(Path path, Charset encoding, boolean considerComments)` Parses the Java code contained in a file 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.
`static AnnotationExpr`	`parseAnnotation(String annotation)` Parses the Java annotation contained in a `String` and returns a `AnnotationExpr` that represents it.
`static BodyDeclaration<?>`	`parseAnnotationBodyDeclaration(String body)` Parses the Java annotation body declaration(e.g fields or methods) contained in a `String` and returns a `BodyDeclaration` that represents it.
`static BlockStmt`	`parseBlock(String blockStatement)` Parses the Java block contained in a `String` and returns a `BlockStmt` 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.
`static Expression`	`parseExpression(String expression)` Parses the Java expression contained in a `String` and returns a `Expression` that represents it.
`ParseResult<CompilationUnit>`	`parseFull(Provider provider)` Parses a compilation unit and its comments.
`static ImportDeclaration`	`parseImport(String importDeclaration)` Parses the Java import contained in a `String` and returns a `ImportDeclaration` 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.
`static Statement`	`parseStatement(String statement)` Parses the Java statement contained in a `String` and returns a `Statement` 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.
`<N> ParseResult<N>`	`parseStructure(ParseContext<N> context, Provider provider)` Parses source code without comments.

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

- Constructor Detail
  - JavaParser
```
public JavaParser(ParserConfiguration configuration)
```
    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
  - parseStructure
```
public <N> ParseResult<N> parseStructure(ParseContext<N> context,
                                         Provider provider)
```
    Parses source code without comments. It takes the source code from a Provider. The context indicates what can be found in the source code (compilation unit, block, import...)
    
    Type Parameters:
    
    N - the subclass of Node that is the result of parsing in the context.
    
    Parameters:
    
    context - refer to the constants in ParseContext to see what can be parsed.
    
    provider - refer to Providers to see how you can read source
    
    Returns:
    
    the parse result and a collection of encountered problems.
  - parseFull
```
public ParseResult<CompilationUnit> parseFull(Provider provider)
```
    Parses a compilation unit and its comments. It takes the source code from a Provider.
    
    Parameters:
    
    provider - refer to Providers to see how you can read source
    
    Returns:
    
    the parse result and a collection of encountered problems.
  - parse
```
public static CompilationUnit parse(InputStream in,
                                    Charset encoding)
```
  - parse
```
public static CompilationUnit parse(InputStream in,
                                    Charset encoding,
                                    boolean considerComments)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parse
```
public 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
    
    Parameters:
    
    in - InputStream containing Java source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
  - parse
```
public static CompilationUnit parse(File file,
                                    Charset encoding)
                             throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - parse
```
public static CompilationUnit parse(File file,
                                    Charset encoding,
                                    boolean considerComments)
                             throws FileNotFoundException
```
    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:
    
    ParseProblemException - if the source code has parser errors
    
    FileNotFoundException
  - parse
```
public static CompilationUnit parse(File file)
                             throws FileNotFoundException
```
    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:
    
    ParseProblemException - if the source code has parser errors
    
    FileNotFoundException - the file was not found
  - parse
```
public static CompilationUnit parse(Path path,
                                    Charset encoding)
                             throws IOException
```
    Throws:
    
    IOException
  - parse
```
public static CompilationUnit parse(Path path,
                                    Charset encoding,
                                    boolean considerComments)
                             throws IOException
```
    Parses the Java code contained in a file and returns a CompilationUnit that represents it.
    
    Parameters:
    
    path - path to a file containing Java source code
    
    encoding - encoding of the source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    IOException - the path could not be accessed
    
    ParseProblemException - if the source code has parser errors
  - parse
```
public static CompilationUnit parse(Path path)
                             throws IOException
```
    Parses the Java code contained in a file and returns a CompilationUnit that represents it.
    Note: Uses UTF-8 encoding
    
    Parameters:
    
    path - path to a file containing Java source code
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
    
    IOException - the path could not be accessed
  - parse
```
public static CompilationUnit parse(Reader reader)
```
  - parse
```
public static CompilationUnit parse(Reader reader,
                                    boolean considerComments)
```
  - parse
```
public static CompilationUnit parse(String code,
                                    boolean considerComments)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parse
```
public static CompilationUnit parse(String code)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseBlock
```
public static BlockStmt parseBlock(String blockStatement)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseStatement
```
public static Statement parseStatement(String statement)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseStatements
```
public static List<Statement> parseStatements(String statements)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseImport
```
public static ImportDeclaration parseImport(String importDeclaration)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseExpression
```
public static Expression parseExpression(String expression)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseAnnotation
```
public static AnnotationExpr parseAnnotation(String annotation)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseAnnotationBodyDeclaration
```
public static BodyDeclaration<?> parseAnnotationBodyDeclaration(String body)
```
    Parses the Java annotation 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:
    
    ParseProblemException - if the source code has parser errors
  - parseClassBodyDeclaration
```
public static BodyDeclaration<?> parseClassBodyDeclaration(String body)
```
    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:
    
    ParseProblemException - if the source code has parser errors
  - parseInterfaceBodyDeclaration
```
public static BodyDeclaration parseInterfaceBodyDeclaration(String body)
```
    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:
    
    ParseProblemException - 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

parseStructure

parseFull

parse

parse

parse

parse

parse

parse

parse

parse

parse

parse

parse

parse

parse

parseBlock

parseStatement

parseStatements

parseImport

parseExpression

parseAnnotation

parseAnnotationBodyDeclaration

parseClassBodyDeclaration

parseInterfaceBodyDeclaration