https://github.com/leodpen/betterbuilder
A Java annotation processor used for automatically generating better builder codes.
https://github.com/leodpen/betterbuilder
builder java-annotation-processor type-safe-builder
Last synced: about 1 month ago
JSON representation
A Java annotation processor used for automatically generating better builder codes.
- Host: GitHub
- URL: https://github.com/leodpen/betterbuilder
- Owner: LEODPEN
- License: mit
- Created: 2021-01-21T16:35:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-16T15:49:08.000Z (over 4 years ago)
- Last Synced: 2025-04-13T18:14:09.635Z (about 1 month ago)
- Topics: builder, java-annotation-processor, type-safe-builder
- Language: Java
- Homepage: https://search.maven.org/artifact/cn.mpy634/BetterBuilder/1.0.8/jar
- Size: 70.3 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BetterBuilder
[](https://github.com/LEODPEN/BetterBuilder/blob/main/LICENSE)
[](https://github.com/LEODPEN/BetterBuilder/releases)
---
BetterBuilder is a [Java annotation processor](https://docs.oracle.com/javase/8/docs/api/javax/annotation/processing/Processor.html) used for
automatically generating **better** builder codes([builder design pattern](https://en.wikipedia.org/wiki/Builder_pattern#Java)),
which can make coding much more comfortable.
### Why better ?
+ [fluent get/set method](#fluentSet-switch)
+ [configurable get/set](#field-ignore).
+ [2 set types provided](#set-type)
+ 3 builder patterns provided:
+ [no builder](#nobuilder-switch)
+ [classic](#usage)
+ [**type safe**](#type-safe-builder)
## Getting BetterBuilder
> BetterBuilder doesn't add any runtime dependencies to your codes.
### Directly reach the jar
Download from [releases](https://github.com/LEODPEN/betterBuilder/releases).
(Just add it to your classpath)
### Maven
BetterBuilder(v1.0.8) has already been published to Central https://repo1.maven.org/maven2/.
Example Maven settings:
```xml
cn.mpy634
BetterBuilder
1.0.8
provided
```
## Usage
> Simple example; [See how to customize](#customization)
Given a class "Student":
```java
import cn.mpy634.annotation.BetterBuilder;
// All configurations are default.
@BetterBuilder
public class Student {
private String name;
private Integer ID;
}
```
The compiled code could be :
```java
public class Student {
private String name;
private Integer ID;
public Student ID(Integer ID) {this.ID = ID;return this;}
public Integer ID() {return this.ID;}
public Student name(String name) {this.name = name;return this;}
public String name() {return this.name;}
public static Student.StudentBuilder builder() {return new Student.StudentBuilder();}
public Student(String name, Integer ID) {this.name = name;this.ID = ID;}
public Student() {}
public static class StudentBuilder {
private String name;
private Integer ID;
private StudentBuilder() {}
public Student.StudentBuilder name(String name) {this.name = name;return this;}
public Student.StudentBuilder ID(Integer ID) {this.ID = ID;return this;}
public Student build() {return new Student(this.name, this.ID);}
}
}
```
Therefore you can code like
`Student stu = Student.builder().ID(xx).name(xx)....build().ID(xx).name(xx)...` .
You can also customize BetterBuilder.
## Customization
### FluentSet switch
Once make `fluentSet = false`, BetterBuilder will not generate set methods.
```java
@BetterBuilder(fluentSet = false)
public class Student {
...
}
```
### FluentGet switch
Once make `fluentGet = false`, BetterBuilder will not generate get methods.
```java
@BetterBuilder(fluentGet = false)
public class Student {
...
}
```
### Set type
Make `setType = 0 / 1` to change the return type of generated set methods.
Given a field `private Integer ID;`, 2 kinds of set methods are available.
When `setType = 0`, which is default( strongly suggested ):
```java
@BetterBuilder(setType = 0)
public class Student {
private Integer ID;
public Student ID(Integer ID){this.ID = ID; return this;}
}
```
when `setType = 1`, set methods will return nothing:
```java
@BetterBuilder(setType = 1)
public class Student {
private Integer ID;
public void ID(Integer ID){this.ID = ID;}
}
```
### NoBuilder switch
Once make `BUILDER_TYPE = BuilderType.NO_BUILDER`, BetterBuilder will not generate builder methods (nor the allArgsConstructor).
```java
@BetterBuilder(BUILDER_TYPE = BuilderType.NO_BUILDER)
public class Student {
...
}
```
### Field ignore
Make any fields annotated with **@IgnoreGet** or **@IgnoreSet**, BetterBuilder will
not generate the get or set methods for them.
```java
@BetterBuilder
public class Student {
@IgnoreSet
private String 牛;
@IgnoreGet
private Integer 年;
@IgnoreGet
@IgnoreSet
private Student 大;
private List 吉;
}
```
It is for those **fields that aren't allowed to be changed or accessed after
initialization**.
### Type-Safe Builder
When we use builder pattern to generate our object, some fields are supposed to be
initialized. But the classic pattern does not guarantee this.
BetterBuilder provides a type-safe builder pattern. Once the fields annotated with
@Required haven't been initialized, the goal object will not be generated ( Instead, an IllegalArgumentException will be thrown ).
```java
@BetterBuilder(BUILDER_TYPE = BuilderType.TYPE_SAFE, fluentSet = false, fluentGet = true)
public class TypeSafe {
@BetterBuilder.Required
private Integer ID;
@BetterBuilder.Required
private String name;
private Boolean PID;
private Long PID79211;
}
```
You can also see the detail files :
[type-safe](https://github.com/LEODPEN/BetterBuilder/blob/main/testModule/src/main/java/TypeSafe.java) and [type-safe-test](https://github.com/LEODPEN/BetterBuilder/blob/main/testModule/src/test/java/TypeSafeTest.java).
## Todo list
- [x] fluent - builder / test
- [x] noBuilder
- [x] fluent - set / test
- [x] chain set options
- [x] ignore set
- [x] fluent - get / test
- [x] ignore get
- [x] compatible with lombok
- [x] type-safe builder
...
## Others
+ Any bugs or suggestions? Plz make PRs or [issues](https://github.com/LEODPEN/BetterBuilder/issues).