JavaPoet

JavaPoet is a Java API for generating .java source files.

Source file generation can be useful when doing things such as annotation processing or interacting with metadata files (e.g., database schemas, protocol formats). By generating code, you eliminate the need to write boilerplate while also keeping a single source of truth for the metadata.

Java-GI fork

This repository contains a fork of github.com/square/javapoet at commit #b9017a9, intended for use with Java-GI. Compared to the original, there are several following modifications:

• Updated package name to org.javagi.javapoet
• Build with Gradle
• Added support for Markdown-formatted Javadoc (JEP 467)
• Generate parts of classes with "raw" CodeBlocks, bypassing the MethodSpec/FieldSpec API

Example

Here's a (boring) HelloWorld class:

packagecom.example.helloworld;publicfinalclass HelloWorld{publicstaticvoidmain(String[]args){System.out.println("Hello, JavaPoet!");}}

And this is the (exciting) code to generate it with JavaPoet:

MethodSpecmain=MethodSpec.methodBuilder("main").addModifiers(Modifier.PUBLIC,Modifier.STATIC).returns(void.class).addParameter(String[].class,"args").addStatement("$T.out.println($S)",System.class,"Hello, JavaPoet!").build();TypeSpechelloWorld=TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC,Modifier.FINAL).addMethod(main).build();JavaFilejavaFile=JavaFile.builder("com.example.helloworld",helloWorld).build();javaFile.writeTo(System.out);

To declare the main method, we've created a MethodSpec "main" configured with modifiers, return type, parameters and code statements. We add the main method to a HelloWorld class, and then add that to a HelloWorld.java file.

In this case we write the file to System.out, but we could also get it as a string (JavaFile.toString()) or write it to the file system (JavaFile.writeTo()).

The Javadoc catalogs the complete JavaPoet API, which we explore below.

Code & Control Flow

Most of JavaPoet's API uses plain old immutable Java objects. There's also builders, method chaining and varargs to make the API friendly. JavaPoet offers models for classes & interfaces (TypeSpec), fields (FieldSpec), methods & constructors (MethodSpec), parameters (ParameterSpec) and annotations (AnnotationSpec).

But the body of methods and constructors is not modeled. There's no expression class, no statement class or syntax tree nodes. Instead, JavaPoet uses strings for code blocks:

MethodSpecmain=MethodSpec.methodBuilder("main").addCode(""+"int total = 0;\n"+"for (int i = 0; i < 10; i++) {\n"+" total += i;\n"+"}\n").build();

Which generates this:

voidmain(){inttotal=0;for(inti=0;i<10;i++){total+=i;}}

The manual semicolons, line wrapping, and indentation are tedious and so JavaPoet offers APIs to make it easier. There's addStatement() which takes care of semicolons and newline, and beginControlFlow() + endControlFlow() which are used together for braces, newlines, and indentation:

MethodSpecmain=MethodSpec.methodBuilder("main").addStatement("int total = 0").beginControlFlow("for (int i = 0; i < 10; i++)").addStatement("total += i").endControlFlow().build();

This example is lame because the generated code is constant! Suppose instead of just adding 0 to 10, we want to make the operation and range configurable. Here's a method that generates a method:

privateMethodSpeccomputeRange(Stringname,intfrom,intto,Stringop){returnMethodSpec.methodBuilder(name).returns(int.class).addStatement("int result = 1").beginControlFlow("for (int i = "+from+"; i < "+to+"; i++)").addStatement("result = result "+op+" i").endControlFlow().addStatement("return result").build();}

And here's what we get when we call computeRange("multiply10to20", 10, 20, "*"):

intmultiply10to20(){intresult=1;for(inti=10;i<20;i++){result=result*i;}returnresult;}

Methods generating methods! And since JavaPoet generates source instead of bytecode, you can read through it to make sure it's right.

Some control flow statements, such as if/else, can have unlimited control flow possibilities. You can handle those options using nextControlFlow():

MethodSpecmain=MethodSpec.methodBuilder("main").addStatement("long now = $T.currentTimeMillis()",System.class).beginControlFlow("if ($T.currentTimeMillis() < now)",System.class).addStatement("$T.out.println($S)",System.class,"Time travelling, woo hoo!").nextControlFlow("else if ($T.currentTimeMillis() == now)",System.class).addStatement("$T.out.println($S)",System.class,"Time stood still!").nextControlFlow("else").addStatement("$T.out.println($S)",System.class,"Ok, time still moving forward").endControlFlow().build();

Which generates:

voidmain(){longnow=System.currentTimeMillis();if(System.currentTimeMillis()<now){System.out.println("Time travelling, woo hoo!");}elseif(System.currentTimeMillis()==now){System.out.println("Time stood still!");}else{System.out.println("Ok, time still moving forward");}}

Catching exceptions using try/catch is also a use case for nextControlFlow():

MethodSpecmain=MethodSpec.methodBuilder("main").beginControlFlow("try").addStatement("throw new Exception($S)","Failed").nextControlFlow("catch ($T e)",Exception.class).addStatement("throw new $T(e)",RuntimeException.class).endControlFlow().build();

Which produces:

voidmain(){try{thrownewException("Failed");}catch(Exceptione){thrownewRuntimeException(e);}}

$L for Literals

The string-concatenation in calls to beginControlFlow() and addStatement is distracting. Too many operators. To address this, JavaPoet offers a syntax inspired-by but incompatible-with String.format(). It accepts $L to emit a literal value in the output. This works just like Formatter's %s:

privateMethodSpeccomputeRange(Stringname,intfrom,intto,Stringop){returnMethodSpec.methodBuilder(name).returns(int.class).addStatement("int result = 0").beginControlFlow("for (int i = $L; i < $L; i++)",from,to).addStatement("result = result $L i",op).endControlFlow().addStatement("return result").build();}

Literals are emitted directly to the output code with no escaping. Arguments for literals may be strings, primitives, and a few JavaPoet types described below.

$S for Strings

When emitting code that includes string literals, we can use $S to emit a string, complete with wrapping quotation marks and escaping. Here's a program that emits 3 methods, each of which returns its own name:

publicstaticvoidmain(String[]args)throwsException{TypeSpechelloWorld=TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC,Modifier.FINAL).addMethod(whatsMyName("slimShady")).addMethod(whatsMyName("eminem")).addMethod(whatsMyName("marshallMathers")).build();JavaFilejavaFile=JavaFile.builder("com.example.helloworld",helloWorld).build();javaFile.writeTo(System.out);}privatestaticMethodSpecwhatsMyName(Stringname){returnMethodSpec.methodBuilder(name).returns(String.class).addStatement("return $S",name).build();}

In this case, using $S gives us quotation marks:

publicfinalclass HelloWorld{StringslimShady(){return"slimShady";}Stringeminem(){return"eminem";}StringmarshallMathers(){return"marshallMathers";}}

$T for Types

We Java programmers love our types: they make our code easier to understand. And JavaPoet is on board. It has rich built-in support for types, including automatic generation of import statements. Just use $T to reference types:

MethodSpectoday=MethodSpec.methodBuilder("today").returns(Date.class).addStatement("return new $T()",Date.class).build();TypeSpechelloWorld=TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC,Modifier.FINAL).addMethod(today).build();JavaFilejavaFile=JavaFile.builder("com.example.helloworld",helloWorld).build();javaFile.writeTo(System.out);

That generates the following .java file, complete with the necessary import:

packagecom.example.helloworld;importjava.util.Date;publicfinalclass HelloWorld{Datetoday(){returnnewDate();}}

We passed Date.class to reference a class that just-so-happens to be available when we're generating code. This doesn't need to be the case. Here's a similar example, but this one references a class that doesn't exist (yet):

ClassNamehoverboard=ClassName.get("com.mattel","Hoverboard");MethodSpectoday=MethodSpec.methodBuilder("tomorrow").returns(hoverboard).addStatement("return new $T()",hoverboard).build();

And that not-yet-existent class is imported as well:

packagecom.example.helloworld;importcom.mattel.Hoverboard;publicfinalclass HelloWorld{Hoverboardtomorrow(){returnnewHoverboard();}}

The ClassName type is very important, and you'll need it frequently when you're using JavaPoet. It can identify any declared class. Declared types are just the beginning of Java's rich type system: we also have arrays, parameterized types, wildcard types, and type variables. JavaPoet has classes for building each of these:

ClassNamehoverboard=ClassName.get("com.mattel","Hoverboard");ClassNamelist=ClassName.get("java.util","List");ClassNamearrayList=ClassName.get("java.util","ArrayList");TypeNamelistOfHoverboards=ParameterizedTypeName.get(list,hoverboard);MethodSpecbeyond=MethodSpec.methodBuilder("beyond").returns(listOfHoverboards).addStatement("$T result = new $T<>()",listOfHoverboards,arrayList).addStatement("result.add(new $T())",hoverboard).addStatement("result.add(new $T())",hoverboard).addStatement("result.add(new $T())",hoverboard).addStatement("return result").build();

JavaPoet will decompose each type and import its components where possible.

packagecom.example.helloworld;importcom.mattel.Hoverboard;importjava.util.ArrayList;importjava.util.List;publicfinalclass HelloWorld{List<Hoverboard>beyond(){List<Hoverboard>result=newArrayList<>();result.add(newHoverboard());result.add(newHoverboard());result.add(newHoverboard());returnresult;}}

Import static

JavaPoet supports import static. It does it via explicitly collecting type member names. Let's enhance the previous example with some static sugar:

...ClassNamenamedBoards=ClassName.get("com.mattel","Hoverboard","Boards");MethodSpecbeyond=MethodSpec.methodBuilder("beyond").returns(listOfHoverboards).addStatement("$T result = new $T<>()",listOfHoverboards,arrayList).addStatement("result.add($T.createNimbus(2000))",hoverboard).addStatement("result.add($T.createNimbus(\"2001\"))",hoverboard).addStatement("result.add($T.createNimbus($T.THUNDERBOLT))",hoverboard,namedBoards).addStatement("$T.sort(result)",Collections.class).addStatement("return result.isEmpty() ? $T.emptyList() : result",Collections.class).build();TypeSpechello=TypeSpec.classBuilder("HelloWorld").addMethod(beyond).build();JavaFile.builder("com.example.helloworld",hello).addStaticImport(hoverboard,"createNimbus").addStaticImport(namedBoards,"*").addStaticImport(Collections.class,"*").build();

JavaPoet will first add your import static block to the file as configured, match and mangle all calls accordingly and also import all other types as needed.

packagecom.example.helloworld;import staticcom.mattel.Hoverboard.Boards.*;import staticcom.mattel.Hoverboard.createNimbus;import staticjava.util.Collections.*;importcom.mattel.Hoverboard;importjava.util.ArrayList;importjava.util.List;class HelloWorld{List<Hoverboard>beyond(){List<Hoverboard>result=newArrayList<>();result.add(createNimbus(2000));result.add(createNimbus("2001"));result.add(createNimbus(THUNDERBOLT));sort(result);returnresult.isEmpty()?emptyList():result;}}

$N for Names

Generated code is often self-referential. Use $N to refer to another generated declaration by its name. Here's a method that calls another:

publicStringbyteToHex(intb){char[]result=newchar[2];result[0]=hexDigit((b>>>4)&0xf);result[1]=hexDigit(b&0xf);returnnewString(result);}publiccharhexDigit(inti){return(char)(i<10?i+'0':i-10+'a');}

When generating the code above, we pass the hexDigit() method as an argument to the byteToHex() method using $N:

MethodSpechexDigit=MethodSpec.methodBuilder("hexDigit").addParameter(int.class,"i").returns(char.class).addStatement("return (char) (i < 10 ? i + '0' : i - 10 + 'a')").build();MethodSpecbyteToHex=MethodSpec.methodBuilder("byteToHex").addParameter(int.class,"b").returns(String.class).addStatement("char[] result = new char[2]").addStatement("result[0] = $N((b >>> 4) & 0xf)",hexDigit).addStatement("result[1] = $N(b & 0xf)",hexDigit).addStatement("return new String(result)").build();

Code block format strings

Code blocks may specify the values for their placeholders in a few ways. Only one style may be used for each operation on a code block.

Relative Arguments

Pass an argument value for each placeholder in the format string to CodeBlock.add(). In each example, we generate code to say "I ate 3 tacos"

CodeBlock.builder().add("I ate $L $L",3,"tacos")

Positional Arguments

Place an integer index (1-based) before the placeholder in the format string to specify which argument to use.

CodeBlock.builder().add("I ate 2ドルL 1ドルL","tacos",3)

Named Arguments

Use the syntax $argumentName:X where X is the format character and call CodeBlock.addNamed() with a map containing all argument keys in the format string. Argument names use characters in a-z, A-Z, 0-9, and _, and must start with a lowercase character.

Map<String,Object>map=newLinkedHashMap<>();map.put("food","tacos");map.put("count",3);CodeBlock.builder().addNamed("I ate $count:L $food:L",map)

Methods

All of the above methods have a code body. Use Modifiers.ABSTRACT to get a method without any body. This is only legal if the enclosing class is either abstract or an interface.

MethodSpecflux=MethodSpec.methodBuilder("flux").addModifiers(Modifier.ABSTRACT,Modifier.PROTECTED).build();TypeSpechelloWorld=TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC,Modifier.ABSTRACT).addMethod(flux).build();

Which generates this:

publicabstractclass HelloWorld{protectedabstractvoidflux();}

The other modifiers work where permitted. Note that when specifying modifiers, JavaPoet uses javax.lang.model.element.Modifier, a class that is not available on Android. This limitation applies to code-generating-code only; the output code runs everywhere: JVMs, Android, and GWT.

Methods also have parameters, exceptions, varargs, Javadoc, annotations, type variables, and a return type. All of these are configured with MethodSpec.Builder.

Constructors

MethodSpec is a slight misnomer; it can also be used for constructors:

MethodSpecflux=MethodSpec.constructorBuilder().addModifiers(Modifier.PUBLIC).addParameter(String.class,"greeting").addStatement("this.$N = $N","greeting","greeting").build();TypeSpechelloWorld=TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC).addField(String.class,"greeting",Modifier.PRIVATE,Modifier.FINAL).addMethod(flux).build();

Which generates this:

publicclass HelloWorld{privatefinalStringgreeting;publicHelloWorld(Stringgreeting){this.greeting=greeting;}}

For the most part, constructors work just like methods. When emitting code, JavaPoet will place constructors before methods in the output file.

Parameters

Declare parameters on methods and constructors with either ParameterSpec.builder() or MethodSpec's convenient addParameter() API:

ParameterSpecandroid=ParameterSpec.builder(String.class,"android").addModifiers(Modifier.FINAL).build();MethodSpecwelcomeOverlords=MethodSpec.methodBuilder("welcomeOverlords").addParameter(android).addParameter(String.class,"robot",Modifier.FINAL).build();

Though the code above to generate android and robot parameters is different, the output is the same:

voidwelcomeOverlords(finalStringandroid,finalStringrobot){}

The extended Builder form is necessary when the parameter has annotations (such as @Nullable).

Fields

Like parameters, fields can be created either with builders or by using convenient helper methods:

FieldSpecandroid=FieldSpec.builder(String.class,"android").addModifiers(Modifier.PRIVATE,Modifier.FINAL).build();TypeSpechelloWorld=TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC).addField(android).addField(String.class,"robot",Modifier.PRIVATE,Modifier.FINAL).build();

Which generates:

publicclass HelloWorld{privatefinalStringandroid;privatefinalStringrobot;}

The extended Builder form is necessary when a field has Javadoc, annotations, or a field initializer. Field initializers use the same String.format()-like syntax as the code blocks above:

FieldSpecandroid=FieldSpec.builder(String.class,"android").addModifiers(Modifier.PRIVATE,Modifier.FINAL).initializer("$S + $L","Lollipop v.",5.0d).build();

Which generates:

privatefinalStringandroid="Lollipop v."+5.0;

Interfaces

JavaPoet has no trouble with interfaces. Note that interface methods must always be PUBLIC ABSTRACT and interface fields must always be PUBLIC STATIC FINAL. These modifiers are necessary when defining the interface:

TypeSpechelloWorld=TypeSpec.interfaceBuilder("HelloWorld").addModifiers(Modifier.PUBLIC).addField(FieldSpec.builder(String.class,"ONLY_THING_THAT_IS_CONSTANT").addModifiers(Modifier.PUBLIC,Modifier.STATIC,Modifier.FINAL).initializer("$S","change").build()).addMethod(MethodSpec.methodBuilder("beep").addModifiers(Modifier.PUBLIC,Modifier.ABSTRACT).build()).build();

But these modifiers are omitted when the code is generated. These are the defaults so we don't need to include them for javac's benefit!

publicinterface HelloWorld{StringONLY_THING_THAT_IS_CONSTANT="change";voidbeep();}

Enums

Use enumBuilder to create the enum type, and addEnumConstant() for each value:

TypeSpechelloWorld=TypeSpec.enumBuilder("Roshambo").addModifiers(Modifier.PUBLIC).addEnumConstant("ROCK").addEnumConstant("SCISSORS").addEnumConstant("PAPER").build();

To generate this:

publicenumRoshambo{ROCK,SCISSORS,PAPER}

Fancy enums are supported, where the enum values override methods or call a superclass constructor. Here's a comprehensive example:

TypeSpechelloWorld=TypeSpec.enumBuilder("Roshambo").addModifiers(Modifier.PUBLIC).addEnumConstant("ROCK",TypeSpec.anonymousClassBuilder("$S","fist").addMethod(MethodSpec.methodBuilder("toString").addAnnotation(Override.class).addModifiers(Modifier.PUBLIC).addStatement("return $S","avalanche!").returns(String.class).build()).build()).addEnumConstant("SCISSORS",TypeSpec.anonymousClassBuilder("$S","peace").build()).addEnumConstant("PAPER",TypeSpec.anonymousClassBuilder("$S","flat").build()).addField(String.class,"handsign",Modifier.PRIVATE,Modifier.FINAL).addMethod(MethodSpec.constructorBuilder().addParameter(String.class,"handsign").addStatement("this.$N = $N","handsign","handsign").build()).build();

Which generates this:

publicenumRoshambo{ROCK("fist"){@OverridepublicStringtoString(){return"avalanche!";}},SCISSORS("peace"),PAPER("flat");privatefinalStringhandsign;Roshambo(Stringhandsign){this.handsign=handsign;}}

Anonymous Inner Classes

In the enum code, we used TypeSpec.anonymousInnerClass(). Anonymous inner classes can also be used in code blocks. They are values that can be referenced with $L:

TypeSpeccomparator=TypeSpec.anonymousClassBuilder("").addSuperinterface(ParameterizedTypeName.get(Comparator.class,String.class)).addMethod(MethodSpec.methodBuilder("compare").addAnnotation(Override.class).addModifiers(Modifier.PUBLIC).addParameter(String.class,"a").addParameter(String.class,"b").returns(int.class).addStatement("return $N.length() - $N.length()","a","b").build()).build();TypeSpechelloWorld=TypeSpec.classBuilder("HelloWorld").addMethod(MethodSpec.methodBuilder("sortByLength").addParameter(ParameterizedTypeName.get(List.class,String.class),"strings").addStatement("$T.sort($N, $L)",Collections.class,"strings",comparator).build()).build();

This generates a method that contains a class that contains a method:

voidsortByLength(List<String>strings){Collections.sort(strings,newComparator<String>(){@Overridepublicintcompare(Stringa,Stringb){returna.length()-b.length();}});}

One particularly tricky part of defining anonymous inner classes is the arguments to the superclass constructor. In the above code we're passing the empty string for no arguments: TypeSpec.anonymousClassBuilder(""). To pass different parameters use JavaPoet's code block syntax with commas to separate arguments.

Annotations

Simple annotations are easy:

MethodSpectoString=MethodSpec.methodBuilder("toString").addAnnotation(Override.class).returns(String.class).addModifiers(Modifier.PUBLIC).addStatement("return $S","Hoverboard").build();

Which generates this method with an @Override annotation:

@OverridepublicStringtoString(){return"Hoverboard";}

Use AnnotationSpec.builder() to set properties on annotations:

MethodSpeclogRecord=MethodSpec.methodBuilder("recordEvent").addModifiers(Modifier.PUBLIC,Modifier.ABSTRACT).addAnnotation(AnnotationSpec.builder(Headers.class).addMember("accept","$S","application/json; charset=utf-8").addMember("userAgent","$S","Square Cash").build()).addParameter(LogRecord.class,"logRecord").returns(LogReceipt.class).build();

Which generates this annotation with accept and userAgent properties:

@Headers(accept="application/json; charset=utf-8",userAgent="Square Cash")LogReceiptrecordEvent(LogRecordlogRecord);

When you get fancy, annotation values can be annotations themselves. Use $L for embedded annotations:

MethodSpeclogRecord=MethodSpec.methodBuilder("recordEvent").addModifiers(Modifier.PUBLIC,Modifier.ABSTRACT).addAnnotation(AnnotationSpec.builder(HeaderList.class).addMember("value","$L",AnnotationSpec.builder(Header.class).addMember("name","$S","Accept").addMember("value","$S","application/json; charset=utf-8").build()).addMember("value","$L",AnnotationSpec.builder(Header.class).addMember("name","$S","User-Agent").addMember("value","$S","Square Cash").build()).build()).addParameter(LogRecord.class,"logRecord").returns(LogReceipt.class).build();

Which generates this:

@HeaderList({@Header(name="Accept",value="application/json; charset=utf-8"),@Header(name="User-Agent",value="Square Cash")})LogReceiptrecordEvent(LogRecordlogRecord);

Note that you can call addMember() multiple times with the same property name to populate a list of values for that property.

Javadoc

Fields, methods and types can be documented with Javadoc:

MethodSpecdismiss=MethodSpec.methodBuilder("dismiss").addJavadoc("Hides {@code message} from the caller's history. Other\n"+"participants in the conversation will continue to see the\n"+"message in their own history unless they also delete it.\n").addJavadoc("\n").addJavadoc("<p>Use {@link #delete($T)} to delete the entire\n"+"conversation for all participants.\n",Conversation.class).addModifiers(Modifier.PUBLIC,Modifier.ABSTRACT).addParameter(Message.class,"message").build();

Which generates this:

/**
 * Hides {@code message} from the caller's history. Other
 * participants in the conversation will continue to see the
 * message in their own history unless they also delete it.
 *
 * <p>Use {@link #delete(Conversation)} to delete the entire
 * conversation for all participants.
 */voiddismiss(Messagemessage);

Use $T when referencing types in Javadoc to get automatic imports.

License

Copyright 2015 Square, Inc.
Copyright 2026 Jan-Willem Harmannij
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.