A very basic library which will generate getters and setters.
Requires Java 21+.
<dependency>
<groupId>dev.mccue</groupId>
<artifactId>magic-bean</artifactId>
<version>2024.04.24</version>
<scope>provided</scope>
</dependency>dependencies {
compileOnly("dev.mccue:magic-bean:2024.04.24")
annotationProcessor("dev.mccue:magic-bean:2024.04.24")
}
This uses an annotation processor to generate a class which can be extended to automatically derive the boilerplate code for
- getters and setters
- equals and hashCode
- toString
- an all argument constructor
The primary goals of this library are
- Boilerplate reduction for code that needs "dumb" POJOs
- Demonstrate that annotation processors and source code generation aren't that scary
- Cover some of the use cases of lombok without the compiler hacking it does
The non-goals of this library are
- To provide a tool which fits all use cases. (conflicts with goal #2)
- Provide a way to generate immutable value objects. Use records, immutables, or elbow grease for that.
- Support old Java versions.
import dev.mccue.magicbean.MagicBean;
import java.util.List;
@MagicBean
public final class Example extends ExampleBeanOps {
int x;
String name;
List<String> strs;
}sealed abstract class ExampleBeanOps extends java.lang.Object permits Example {
/**
* Get the current value for x.
*/
public int getX() {
return (switch (this) { case Example __ -> __; }).x;
}
/**
* Set the current value for x.
*/
public void setX(int x) {
(switch (this) { case Example __ -> __; }).x = x;
}
/**
* Get the current value for name.
*/
public java.lang.String getName() {
return (switch (this) { case Example __ -> __; }).name;
}
/**
* Set the current value for name.
*/
public void setName(java.lang.String name) {
(switch (this) { case Example __ -> __; }).name = name;
}
/**
* Get the current value for strs.
*/
public java.util.List<java.lang.String> getStrs() {
return (switch (this) { case Example __ -> __; }).strs;
}
/**
* Set the current value for strs.
*/
public void setStrs(java.util.List<java.lang.String> strs) {
(switch (this) { case Example __ -> __; }).strs = strs;
}
}import dev.mccue.magicbean.MagicBean;
import java.util.List;
@MagicBean(
allArgsStaticFactory = true,
equalsAndHashCode = true,
toString_ = true
)
public final class Example extends ExampleBeanOps {
int x;
String name;
List<String> strs;
}sealed abstract class ExampleBeanOps extends java.lang.Object permits Example {
/**
* Creates an instance of Example.
*/
public static Example of(
int x,
java.lang.String name,
java.util.List<java.lang.String> strs
) {
var o = new Example();
o.setX(x);
o.setName(name);
o.setStrs(strs);
return o;
}
/**
* Get the current value for x.
*/
public int getX() {
return (switch (this) { case Example __ -> __; }).x;
}
/**
* Set the current value for x.
*/
public void setX(int x) {
(switch (this) { case Example __ -> __; }).x = x;
}
/**
* Get the current value for name.
*/
public java.lang.String getName() {
return (switch (this) { case Example __ -> __; }).name;
}
/**
* Set the current value for name.
*/
public void setName(java.lang.String name) {
(switch (this) { case Example __ -> __; }).name = name;
}
/**
* Get the current value for strs.
*/
public java.util.List<java.lang.String> getStrs() {
return (switch (this) { case Example __ -> __; }).strs;
}
/**
* Set the current value for strs.
*/
public void setStrs(java.util.List<java.lang.String> strs) {
(switch (this) { case Example __ -> __; }).strs = strs;
}
@Override
public boolean equals(Object o) {
if (o == null || !(o instanceof Example other)) {
return false;
}
else {
return java.util.Objects.equals((switch (this) { case Example __ -> __; }).x, other.x) &&
java.util.Objects.equals((switch (this) { case Example __ -> __; }).name, other.name) &&
java.util.Objects.equals((switch (this) { case Example __ -> __; }).strs, other.strs);
}
}
@Override
public int hashCode() {
return java.util.Objects.hash(
(switch (this) { case Example __ -> __; }).x,
(switch (this) { case Example __ -> __; }).name,
(switch (this) { case Example __ -> __; }).strs
);
}
@Override
public String toString() {
return "Example[" + "x=" + (switch (this) { case Example __ -> __; }).x +
", " + "name=" + (switch (this) { case Example __ -> __; }).name +
", " + "strs=" + (switch (this) { case Example __ -> __; }).strs + "]";
}
}This library is just about 350 lines of Java contained within a single file. If it doesn't do exactly what you want, feel free to make a PR or fork and make your own edits.