JavaParser: Java Code Generation

JavaParser: Java Code Generation

In this article, I’m going to show you how to generate Java code using theJavaParser.

In this article, I’m going to show you how to generate Java code using theJavaParser.

Looking to learn more about using the JavaParser in your projects?

I couldn’t find much of the documentation available with regards to code generation in javaparser.org or the manual. So, I thought putting this out would help someone who would like to experiment with the Java parser.

In its simplest form, the JavaParser library allows you to interact with Java source code as a Java object representation in a Java environment. More formally, we refer to this object representation as an Abstract Syntax Tree (AST). Also, it has the ability to manipulate the underlying structure of the source code. This can then be written to a file, providing developers with the facility to build their own code generating software.

First up, you have to instantiate the compilation unit, upon which you will add the remaining pieces of the code.

CompilationUnit compilationUnit = new CompilationUnit();

Then, you can add your import statements to the compilation unit, here:

compilationUnit.addImport("org.springframework.boot.SpringApplication");

You can add your package statement to the compilation unit, as shown below:

compilationUnit.setPackageDeclaration("com.abc.def");

You can add the class declaration to the Java file:

ClassOrInterfaceDeclaration classDeclaration = compilationUnit.addClass("AnyClassName").setPublic(true);

If you want to add annotations at the class level, you can use the following code:

classDeclaration.addAnnotation("AnyAnnotation");

You can add method declarations within your newly declared class, as shown below:

MethodDeclaration methodDeclaration = classDeclaration.addMethod("anyMethodName", PUBLIC);
methodDeclaration.setType("AnyReturnType");

You can add arguments to your newly created method declaration:

methodDeclaration.addAndGetParameter(String.class, "args").setVarArgs(true);

Add annotations on top of the newly declared method:

methodDeclaration.addAndGetAnnotation("AnyAnnotation");

To add the method logic/block statement within the newly declared method, use the below code:

BlockStmt blockStmt = new BlockStmt();
methodDeclaration.setBody(blockStmt);

To declare and instantiate a variable within the method/block statement, use the following code:

ExpressionStmt expressionStmt = new ExpressionStmt();
VariableDeclarationExpr variableDeclarationExpr = new VariableDeclarationExpr();
VariableDeclarator variableDeclarator = new VariableDeclarator();
variableDeclarator.setName("anyVariableName");
variableDeclarator.setType(new ClassOrInterfaceType("AnyVariableType"));
variableDeclarator.setInitializer("new AnyVariableType()");
NodeList<VariableDeclarator> variableDeclarators = new NodeList<>();
variableDeclarators.add(variableDeclarator);
variableDeclarationExpr.setVariables(variableDeclarators);
expressionStmt.setExpression(variableDeclarationExpr);

blockStmt.addStatement(expressionStmt);

To invoke a method of the new variable created within the method/block statement, use the below code:

NameExpr nameExpr = new NameExpr("anyVariableName");
MethodCallExpr methodCallExpr = new MethodCallExpr(nameExpr, "anyMethodName");
methodCallExpr.addArgument("anyArgument");

blockStmt.addStatement(methodCallExpr);

To return the variable created in the method, use the code below:

ReturnStmt returnStmt = new ReturnStmt();
NameExpr returnNameExpr = new NameExpr();
returnNameExpr.setName("anyVariableName");
returnStmt.setExpression(returnNameExpr);

blockStmt.addStatement(returnStmt);

To print the code generated above, just call the toString method of the compilation unit:

String code = compilationUnit.toString();

To add an annotation with multi-valued key value pairs, use the below code.

NodeList<Expression> annotationParamValueList = new NodeList<>();
annotationParamValueList.add(new StringLiteralExpr("Value1");
annotationParamValueList.add(new StringLiteralExpr("Value2");
ArrayInitializerExpr annotationParamValueArrayInitializerExpr = new ArrayInitializerExpr(annotationParamValueList);
Name annotationName = new Name("AnyAnnotationName");
NodeList<MemberValuePair> annotationParamList = new NodeList<>();
MemberValuePair memberValuePair = new MemberValuePair();
memberValuePair.setName(new SimpleName("AnyValue"));
memberValuePair.setValue(annotationParamValueArrayInitializerExpr);
annotationParamList.add(memberValuePair);
AnnotationExpr annotationExpr = new NormalAnnotationExpr(annotationName, annotationParamList);

java

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

How to Install OpenJDK 11 on CentOS 8

What is OpenJDK? OpenJDk or Open Java Development Kit is a free, open-source framework of the Java Platform, Standard Edition (or Java SE).

Java Core (2020) | Java for beginners | Brush up your Java Skills | Get Hired

In this video we will learn about all the major concepts that come under Java Core . The course is very carefully designed and is made with keeping simplicit...

Java File Class Tutorial | Java.io File Class in Java Example

Java File class represents the path of directories and files. It provides the methods for renaming, deleting, and obtaining the properties of file or directory.

Best Ways To Improve Skills In Java and Python Programming

Join CETPA, India's best institute for Java online training and Certification Course. Enroll now to learn Core to Advanced Java & avail 50% discount on Java Online Course with Certificate.

Java Fundamentals: Learn Java for absolute beginners |Simpliv

Java Fundamentals: Learn Java for absolute beginners