JavaParser (javaparser-core 3.1.1 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()
Instantiate the parser with default configuration.

JavaParser(ParserConfiguration configuration)
Instantiate the parser.

Constructors
Constructor and Description
`JavaParser()` Instantiate the parser with default configuration.
`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)` 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)` Parses the Java code contained in the `InputStream` and returns a `CompilationUnit` that represents it.
`<N extends Node> ParseResult<N>`	`parse(ParseStart<N> start, Provider provider)` Parses source code.
`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)` Parses the Java code contained in a file and returns a `CompilationUnit` that represents it.
`static CompilationUnit`	`parse(Reader reader)` Parses Java code from a Reader and returns a `CompilationUnit` that represents it.
`static CompilationUnit`	`parse(String code)` 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 ClassOrInterfaceType`	`parseClassOrInterfaceType(String type)` Parses a Java type name and returns a `ClassOrInterfaceType` that represents it.
`static ExplicitConstructorInvocationStmt`	`parseExplicitConstructorInvocationStmt(String statement)` Parses the this(...) and super(...) statements that may occur at the start of a constructor.
`static <T extends Expression> T`	`parseExpression(String expression)` Parses the Java expression contained in a `String` and returns a `Expression` that represents it.
`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 Javadoc`	`parseJavadoc(String content)` Parses the content of a JavadocComment and returns a `Javadoc` that represents it.
`static Name`	`parseName(String qualifiedName)` Parses a qualified name (one that can have "."s in it) and returns it as a Name.
`static Parameter`	`parseParameter(String parameter)` Parses a single parameter (a type and a name) and returns it as a Parameter.
`static CompilationUnit`	`parseResource(ClassLoader classLoader, String path, Charset encoding)` Parses the Java code contained in a resource and returns a `CompilationUnit` that represents it.
`static CompilationUnit`	`parseResource(String path)` Parses the Java code contained in a resource and returns a `CompilationUnit` that represents it. Note: Uses UTF-8 encoding
`static CompilationUnit`	`parseResource(String path, Charset encoding)` Parses the Java code contained in a resource and returns a `CompilationUnit` that represents it.
`static Statement`	`parseStatement(String statement)` Parses the Java statement contained in a `String` and returns a `Statement` that represents it.
`static VariableDeclarationExpr`	`parseVariableDeclarationExpr(String declaration)` Parses a variable declaration expression and returns a `VariableDeclarationExpr` that represents it.

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 with default configuration. Note that parsing can also be done with the static methods on this class. Creating an instance will reduce setup time between parsing files.
  - 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
  - parse
```
public <N extends Node> ParseResult<N> parse(ParseStart<N> start,
                                             Provider provider)
```
    Parses source code. It takes the source code from a Provider. The start 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 start.
    
    Parameters:
    
    start - refer to the constants in ParseStart to see what can be parsed.
    
    provider - refer to Providers to see how you can read source.
    
    Returns:
    
    the parse result, a collection of encountered problems, and some extra data.
  - parse
```
public static CompilationUnit parse(InputStream in,
                                    Charset encoding)
```
    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
```
    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 - the file was not found
  - 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
```
    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
  - parseResource
```
public static CompilationUnit parseResource(String path)
                                     throws IOException
```
    Parses the Java code contained in a resource and returns a CompilationUnit that represents it.
    Note: Uses UTF-8 encoding
    
    Parameters:
    
    path - path to a resource containing Java source code. As resource is accessed through a class loader, a leading "/" is not allowed in pathToResource
    
    Returns:
    
    CompilationUnit representing the Java source code
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
    
    IOException - the path could not be accessed
  - parseResource
```
public static CompilationUnit parseResource(String path,
                                            Charset encoding)
                                     throws IOException
```
    Parses the Java code contained in a resource and returns a CompilationUnit that represents it.
    
    Parameters:
    
    path - path to a resource containing Java source code. As resource is accessed through a class loader, a leading "/" is not allowed in pathToResource
    
    encoding - encoding of the 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
  - parseResource
```
public static CompilationUnit parseResource(ClassLoader classLoader,
                                            String path,
                                            Charset encoding)
                                     throws IOException
```
    Parses the Java code contained in a resource and returns a CompilationUnit that represents it.
    
    Parameters:
    
    classLoader - the classLoader that is asked to load the resource
    
    path - path to a resource containing Java source code. As resource is accessed through a class loader, a leading "/" is not allowed in pathToResource
    
    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)
```
    Parses Java code from a Reader and returns a CompilationUnit that represents it.
    
    Parameters:
    
    reader - the reader 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(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
  - 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 <T extends Expression> T 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
  - parseClassOrInterfaceType
```
public static ClassOrInterfaceType parseClassOrInterfaceType(String type)
```
    Parses a Java type name and returns a ClassOrInterfaceType that represents it.
    
    Parameters:
    
    type - the type name like a.b.c.X or Y
    
    Returns:
    
    ClassOrInterfaceType representing the type
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
  - parseVariableDeclarationExpr
```
public static VariableDeclarationExpr parseVariableDeclarationExpr(String declaration)
```
    Parses a variable declaration expression and returns a VariableDeclarationExpr that represents it.
    
    Parameters:
    
    declaration - a variable declaration like int x=2;
    
    Returns:
    
    VariableDeclarationExpr representing the type
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
  - parseJavadoc
```
public static Javadoc parseJavadoc(String content)
```
    Parses the content of a JavadocComment and returns a Javadoc that represents it.
    
    Parameters:
    
    content - a variable declaration like content of my javadoc\n * second line\n * third line
    
    Returns:
    
    Javadoc representing the content of the comment
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
  - parseExplicitConstructorInvocationStmt
```
public static ExplicitConstructorInvocationStmt parseExplicitConstructorInvocationStmt(String statement)
```
    Parses the this(...) and super(...) statements that may occur at the start of a constructor.
    
    Parameters:
    
    statement - a statement like super("hello");
    
    Returns:
    
    the AST for the statement.
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
  - parseName
```
public static Name parseName(String qualifiedName)
```
    Parses a qualified name (one that can have "."s in it) and returns it as a Name.
    
    Parameters:
    
    qualifiedName - a name like "com.laamella.parameter_source"
    
    Returns:
    
    the AST for the name
    
    Throws:
    
    ParseProblemException - if the source code has parser errors
  - parseParameter
```
public static Parameter parseParameter(String parameter)
```
    Parses a single parameter (a type and a name) and returns it as a Parameter.
    
    Parameters:
    
    parameter - a parameter like "int[] x"
    
    Returns:
    
    the AST for the parameter
    
    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

JavaParser

Method Detail

parse

parse

parse

parse

parse

parse

parse

parseResource

parseResource

parseResource

parse

parse

parseBlock

parseStatement

parseImport

parseExpression

parseAnnotation

parseAnnotationBodyDeclaration

parseClassBodyDeclaration

parseInterfaceBodyDeclaration

parseClassOrInterfaceType

parseVariableDeclarationExpr

parseJavadoc

parseExplicitConstructorInvocationStmt

parseName

parseParameter