square/javapoetArchived
Javapoet
JavaPoet is a source code generator and metaprogramming utility for the Java language. It functions as an abstract syntax tree construction library that allows developers to model classes, methods, and fields as objects before emitting them as source code.
The library distinguishes itself through automatic import management and code formatting. It tracks referenced types to generate required import statements and handles line wrapping, semicolon placement, and indentation to ensure generated files remain readable.
The tool covers a broad range of generation capabilities, including the definition of type structures such as interfaces and enums, the declaration of annotations, and the composition of method bodies. It provides mechanisms for injecting dynamic values and type references into code blocks and can emit the final source to the file system, strings, or output streams.
Features
- Source Code Abstract Syntax Trees - Models Java source files as a hierarchy of objects, allowing programmatic manipulation of the code structure before emission.
- Source Code Generators - Programmatically generates valid Java source code files from structured object representations.
- Import Management - Automatically resolves and generates the required import statements based on the classes used in the code.
- AST Construction Libraries - Models Java classes, methods, and fields as objects in an abstract syntax tree before emitting them as source code.
- Dynamic Type Modeling - Allows creating strongly typed Java class structures and method bodies through an API instead of string concatenation.
- Fluent Interface Patterns - Provides a fluent API builder pattern for programmatically constructing Java classes, methods, and fields.
- Import Resolution Tracking - Maintains a registry of referenced classes to automatically generate the necessary import statements in the resulting Java file.
- Metaprogramming Frameworks - Provides a framework for automating the creation of boilerplate Java code based on external metadata.
- Type Modeling APIs - Provides strongly typed specifications for modeling Java classes, interfaces, enums, fields, and methods.
- Method Body Composition - Allows writing executable code blocks with automated indentation and semicolon placement via a string-based interface.
- Type Structure Generation - Provides APIs to model and generate Java classes, interfaces, and enums with specific modifiers and members.
- Automated API Generation - Enables the automatic generation of API layers, classes, and interfaces based on external metadata or schemas.
- Code Formatting Tools - Automatically handles line wrapping, semicolon placement, and indentation for generated Java source files.
- Indentation Rules - Implements structural indentation logic to ensure generated Java source code follows consistent nesting and line wrapping.
- Source Code Emission - Writes generated source code to the file system, a string, or an output stream.
- Source Code File Emission - Exports generated Java source code directly to the file system with configurable character sets.
- String Formatting Utilities - Uses a specialized token system to inject dynamic literals and type references into formatted code blocks.
- Qualified Name Resolution - Prevents naming collisions by automatically deciding between simple class names and fully qualified type paths.
- Type Qualifier Management - Handles fully-qualified and nested type names to prevent naming collisions in the generated Java source.
- Code Block Value Injection - Embeds literals and type references into code blocks using a specialized formatting syntax.
- Code Annotations - Supports adding structured metadata annotations to classes, methods, and fields during code generation.
- Code Formatting - Ensures high readability of generated code through line wrapping and named placeholders in code blocks.
- Code Literal Formatting - Inserts escaped strings and type references into code blocks using a specialized placeholder syntax.
- Advanced Development Frameworks - API for generating Java source files.
- Code Generation and Bytecode - API for generating Java source files.
- Code Generators - API for generating Java source files.
- Metaprogramming and Compilers - API for generating Java source files.
