readme.md
1# JavaParser
2
3[](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.github.javaparser%22%20AND%20a%3A%22javaparser-core%22)
4[](https://travis-ci.org/javaparser/javaparser)
5[](https://coveralls.io/github/javaparser/javaparser?branch=master)
6[](https://gitter.im/javaparser/javaparser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
7
8This project contains a set of libraries implementing a Java 1.0 - Java 9 Parser with advanced analysis functionalities.
9
10Our main site is at [JavaParser.org](http://javaparser.org)
11
12## Setup
13
14The project binaries are available in Maven Central.
15
16We strongly advises users to adopt Maven, Gradle or another build system for their projects. If you are not familiar with them
17we suggest taking a look at the maven quickstart projects
18([javaparser-maven-sample](https://github.com/javaparser/javaparser-maven-sample),
19[javasymbolsolver-maven-sample](https://github.com/javaparser/javasymbolsolver-maven-sample)).
20
21Just add the following to your maven configuration or tailor to your own dependency management system.
22
23[Please refer to the Migration Guide when upgrading from 2.5.1 to 3.0.0+](https://github.com/javaparser/javaparser/wiki/Migration-Guide)
24
25**Maven**:
26
27```xml
28<dependency>
29 <groupId>com.github.javaparser</groupId>
30 <artifactId>javaparser-symbol-solver-core</artifactId>
31 <version>3.5.15</version>
32</dependency>
33```
34
35**Gradle**:
36
37```
38compile 'com.github.javaparser:javaparser-symbol-solver-core:3.5.15'
39```
40
41Since Version 3.5.10, the JavaParser project includes the JavaSymbolSolver.
42While JavaParser generates an Abstract Syntax Tree, JavaSymbolSolver analyzes that AST and is able to find
43the relation between an element and its declaration (e.g. for a variable name it could be a parameter of a method, providing information about its type, position in the AST, ect).
44
45Using the dependency above will add both JavaParser and JavaSymbolSolver to your project. If you only need the core functionality of parsing Java source code in order to traverse and manipulate the generated AST, you can reduce your projects boilerplate by only including JavaParser to your project:
46
47**Maven**:
48
49```xml
50<dependency>
51 <groupId>com.github.javaparser</groupId>
52 <artifactId>javaparser-core</artifactId>
53 <version>3.5.15</version>
54</dependency>
55```
56
57**Gradle**:
58
59```
60compile 'com.github.javaparser:javaparser-core:3.5.15'
61```
62
63## How To Compile Sources
64
65If you checked out the project from GitHub you can build the project with maven using:
66
67```
68mvn clean install
69```
70
71If you checkout the sources and want to view the project in an IDE, it is best to first generate some of the source files; otherwise you will get many compilation complaints in the IDE. (mvn clean install already does this for you.)
72
73```
74mvn javacc:javacc
75```
76
77If you modify the code of the AST nodes, specifically if you add or remove fields or node classes,
78the code generators will update a lot of code for you.
79The `run_metamodel_generator.sh` script will rebuild the metamodel,
80which is used by the code generators which are run by `run_core_generators.sh`
81Make sure that `javaparser-core` at least compiles before you run these.
82
83## More information
84
85#### [JavaParser.org](https://www.javaparser.org) is the main information site.
86
87## License
88
89JavaParser is available either under the terms of the LGPL License or the Apache License. You as the user are entitled to choose the terms under which adopt JavaParser.
90
91For details about the LGPL License please refer to [LICENSE.LGPL](ttps://github.com/javaparser/javaparser/blob/master/LICENSE.LGPL).
92
93For details about the Apache License please refer to [LICENSE.APACHE](ttps://github.com/javaparser/javaparser/blob/master/LICENSE.APACHE).
94
