How does ADT4J compare to using Lombok for reducing Java boilerplate?

ADT4J is specialized for algebraic data types and pattern matching, generating code for complex, recursive structures, while Lombok is general-purpose for getters, setters, and builders. Choose ADT4J for functional-style data modeling, but Lombok for everyday class enhancements.

Can I use ADT4J with Gradle instead of Maven?

Yes, ADT4J should work with Gradle as it relies on annotation processors, but you need to configure the annotation processor path correctly in your build.gradle. Check the documentation or community examples for specific setup instructions to avoid issues.

What are the performance implications of ADT4J generated classes?

Runtime performance is similar to manual Java code since it generates standard classes, but compilation can be slower due to annotation processing. The visitor pattern for pattern matching may add slight overhead compared to direct method calls.

How to handle serialization with ADT4J if I enable the Serializable option?

When you use the option to generate Serializable implementations, ADT4J creates classes with proper serialVersionUID and checks at compile-time. Ensure all member types are serializable, and test thoroughly as serialization in recursive types can be complex.

Does ADT4J support Java 8+ features like lambdas in pattern matching?

Yes, ADT4J is compatible with Java 7 and later, so you can use lambdas in Java 8+ for implementing visitor interfaces, making the code more concise. The generated classes are standard Java, allowing integration with modern language features.

What should I do if I get duplicate class errors with ADT4J in Maven?

This is a known issue with maven-compiler-plugin 3.2+. Workarounds include downgrading the plugin, using clean builds, or switching to the adt4j-shaded artifact to avoid dependency conflicts. Refer to the README for details on these solutions.

Open-Awesome

ADT4J

BSD-3-ClauseJavaadt4j-2.0.1

A Java annotation processor for generating algebraic data types with value semantics, pattern matching, and customizable APIs.

GitHub

150 stars9 forks0 contributors

What is ADT4J?

ADT4J is a Java library that implements algebraic data types (ADTs) through an annotation processor. It generates boilerplate code for custom data types, enabling pattern matching, value semantics, and recursive definitions in Java. The project solves the problem of verbose and error-prone manual implementation of ADTs in a language lacking native support.

Target Audience

Java developers working on projects that benefit from algebraic data types, such as compilers, interpreters, or complex domain models, and those seeking type-safe pattern matching without switching languages.

Value Proposition

Developers choose ADT4J for its ability to bring functional programming constructs to Java with minimal boilerplate, customizable generated code, and compatibility with existing Java tooling and inheritance.

Overview

adt4j - Algebraic Data Types for Java

Use Cases

Best For

Implementing expression trees or abstract syntax trees in Java
Reducing boilerplate in domain models with complex data shapes
Adding type-safe pattern matching to Java applications
Creating recursive data structures with automatic value semantics
Generating serializable and comparable implementations for custom types
Experimenting with algebraic data types in a Java ecosystem

Not Ideal For

Projects relying on Maven 3.2+ for incremental builds, due to known duplicate class errors that require clean compilations
Applications where compilation speed is critical, as annotation processors can slow down the build process
Teams that prefer to maintain all code manually without generation, for better control and debugging
Simple domain models where standard Java classes suffice and algebraic data types add unnecessary complexity

Pros & Cons

Pros

Recursive Data Support

Supports recursive definitions without special handling, enabling easy creation of complex structures like expression trees, as shown in the Expression example.

Value Semantics Generation

Automatically generates hashCode, equals, and toString with value semantics, reducing boilerplate and ensuring consistency in data comparisons.

Customizable API

Allows custom names and access levels for generated methods like predicates and getters, providing flexibility in API design, as per the @Getter annotations.

Visitor-Based Pattern Matching

Implements type-safe pattern matching through visitors, enabling clear and safe operations on data variants, demonstrated in the eval() method example.

Cons

Build Tool Incompatibilities

Known issues with maven-compiler-plugin version 3.2+ cause duplicate class errors on repeated compilations, requiring clean builds and disrupting development workflow.

Javac Bug Workarounds

Requires a hack (selfReferenceVariableName) for recursive types with generics due to a javac bug, making definitions less elegant and potentially error-prone.

Annotation Processor Overhead

Dependency on annotation processing complicates build setup and can increase compilation time, especially in large projects or with frequent changes.

Frequently Asked Questions

Related Projects

JHipster

JHipster is a development platform to quickly generate, develop, & deploy modern web applications & microservice architectures.

Stars22,447

Forks4,189

Last commit10 hours ago

JavaPoet

A Java API for generating .java source files.

Stars10,847

Forks1,395

Last commit1 year ago

auto

A collection of source code generators for Java.

Stars10,555

Forks1,224

Last commit3 days ago

Record-Builder

Record builder generator for Java records

Stars929

Forks69

Last commit1 month ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub