Codelizer is a platform to analyze the source code of java projects, it subtracts data and metrics from your code with the goal of be processed and used for your own purposes.
The platform is composed of multiple services.
Specifically the Codelizer service (This repository) is the agent
that processes the java source code of the projects and collects information
about:
- The declared classes
- The declared methods
- The parameters declared on each method
- The documentation of classes and methods
- The documentation of method parameters
The agent only collects information and puts it into the database, what to do with that info is out of the scope of this service, that is responsibility of another components of platform.
The database looks like:
This service exposes a list of web services, the idea is that another system invokes that web services. Once that web service is invoked, each java file of a given project is analyzed. A grammar tree is built and the relevant element are subtracted from this tree. In resume:
- A webservice is invoked to start the analysis
- The service looks for all java files in root folder of specified project
- Each java file is processed and a grammar tree is generated
- The relevant items are subtracted from the grammar tree
- The subtracted elements are stored into the database
Compile with:
mvn clean installRun it with:
java -jar <file.jar>