• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..--

dev-files/23-Nov-2023-334333

doc/23-Nov-2023-2929

javaparser-core/23-Nov-2023-84,83762,297

javaparser-core-generators/23-Nov-2023-1,7891,389

javaparser-core-metamodel-generator/23-Nov-2023-586493

javaparser-core-serialization/23-Nov-2023-762509

javaparser-core-testing/23-Nov-2023-22,02617,419

javaparser-core-testing-bdd/23-Nov-2023-5,8524,420

javaparser-symbol-solver-core/23-Nov-2023-22,14915,161

javaparser-symbol-solver-logic/23-Nov-2023-753503

javaparser-symbol-solver-model/23-Nov-2023-372197

javaparser-symbol-solver-testing/23-Nov-2023-126,00297,147

.gitignoreD23-Nov-2023306 2824

.travis.ymlD23-Nov-2023795 2522

Android.bpD23-Nov-20232.8 KiB8576

CONTRIBUTING.mdD23-Nov-20232.5 KiB3124

LICENSED23-Nov-2023382 74

LICENSE.APACHED23-Nov-202311.1 KiB203169

LICENSE.GPLD23-Nov-202335 KiB675553

LICENSE.LGPLD23-Nov-20237.6 KiB166128

METADATAD23-Nov-2023469 2019

OWNERSD23-Nov-2023220 65

PULL_REQUEST_TEMPLATE.mdD23-Nov-202313 21

appveyor.ymlD23-Nov-2023877 2726

changelog.mdD23-Nov-202340.1 KiB1,020817

fixup.shD23-Nov-20231,016 4233

pom.xmlD23-Nov-202314.1 KiB368356

readme.mdD23-Nov-20234.5 KiB11478

ruleset.xmlD23-Nov-20235.3 KiB145144

run_core_generators.shD23-Nov-2023440 207

run_core_metamodel_generator.shD23-Nov-2023562 2511

readme.md

1# JavaParser
2
3[![Maven Central](https://img.shields.io/maven-central/v/com.github.javaparser/javaparser-core.svg)](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.github.javaparser%22%20AND%20a%3A%22javaparser-core%22)
4[![Build Status](https://travis-ci.org/javaparser/javaparser.svg?branch=master)](https://travis-ci.org/javaparser/javaparser)
5[![Coverage Status](https://coveralls.io/repos/javaparser/javaparser/badge.svg?branch=master&service=github)](https://coveralls.io/github/javaparser/javaparser?branch=master)
6[![Join the chat at https://gitter.im/javaparser/javaparser](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/javaparser/javaparser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
7[![License LGPL-3/Apache-2.0](https://img.shields.io/badge/license-LGPL--3%2FApache--2.0-blue.svg)](LICENSE)
8
9This project contains a set of libraries implementing a Java 1.0 - Java 12 Parser with advanced analysis functionalities.
10
11Our main site is at [JavaParser.org](http://javaparser.org)
12
13## Setup
14
15The project binaries are available in Maven Central.
16
17We strongly advise users to adopt Maven, Gradle or another build system for their projects.
18If you are not familiar with them we suggest taking a look at the maven quickstart projects
19([javaparser-maven-sample](https://github.com/javaparser/javaparser-maven-sample),
20[javasymbolsolver-maven-sample](https://github.com/javaparser/javasymbolsolver-maven-sample)).
21
22Just add the following to your maven configuration or tailor to your own dependency management system.
23
24[Please refer to the Migration Guide when upgrading from 2.5.1 to 3.0.0+](https://github.com/javaparser/javaparser/wiki/Migration-Guide)
25
26**Maven**:
27
28```xml
29<dependency>
30    <groupId>com.github.javaparser</groupId>
31    <artifactId>javaparser-symbol-solver-core</artifactId>
32    <version>3.14.9</version>
33</dependency>
34```
35
36**Gradle**:
37
38```
39implementation 'com.github.javaparser:javaparser-symbol-solver-core:3.14.9'
40```
41
42Since Version 3.5.10, the JavaParser project includes the JavaSymbolSolver.
43While JavaParser generates an Abstract Syntax Tree, JavaSymbolSolver analyzes that AST and is able to find
44the 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).
45
46Using 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:
47
48**Maven**:
49
50```xml
51<dependency>
52    <groupId>com.github.javaparser</groupId>
53    <artifactId>javaparser-core</artifactId>
54    <version>3.14.9</version>
55</dependency>
56```
57
58**Gradle**:
59
60```
61implementation 'com.github.javaparser:javaparser-core:3.14.9'
62```
63
64Since version 3.6.17 the AST can be serialized to JSON.
65There is a separate module for this:
66
67**Maven**:
68
69```xml
70<dependency>
71    <groupId>com.github.javaparser</groupId>
72    <artifactId>javaparser-core-serialization</artifactId>
73    <version>3.14.9</version>
74</dependency>
75```
76
77**Gradle**:
78
79```
80implementation 'com.github.javaparser:javaparser-core-serialization:3.14.9'
81```
82
83## How To Compile Sources
84
85If you checked out the project from GitHub you can build the project with maven using:
86
87```
88mvn clean install
89```
90
91If 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.)
92
93```
94mvn javacc:javacc
95```
96
97If you modify the code of the AST nodes, specifically if you add or remove fields or node classes,
98the code generators will update a lot of code for you.
99The `run_metamodel_generator.sh` script will rebuild the metamodel,
100which is used by the code generators which are run by `run_core_generators.sh`
101Make sure that `javaparser-core` at least compiles before you run these.
102
103## More information
104
105#### [JavaParser.org](https://javaparser.org) is the main information site.
106
107## License
108
109JavaParser 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.
110
111For details about the LGPL License please refer to [LICENSE.LGPL](ttps://github.com/javaparser/javaparser/blob/master/LICENSE.LGPL).
112
113For details about the Apache License please refer to [LICENSE.APACHE](ttps://github.com/javaparser/javaparser/blob/master/LICENSE.APACHE).
114