Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bowbahdoe/magic-bean
A very basic library which will generate getters and setters.
https://github.com/bowbahdoe/magic-bean
annotation-processor code-generation java
Last synced: 7 days ago
JSON representation
A very basic library which will generate getters and setters.
- Host: GitHub
- URL: https://github.com/bowbahdoe/magic-bean
- Owner: bowbahdoe
- License: other
- Created: 2022-01-20T00:58:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T20:55:49.000Z (7 months ago)
- Last Synced: 2024-04-27T21:05:45.172Z (7 months ago)
- Topics: annotation-processor, code-generation, java
- Language: Java
- Homepage:
- Size: 397 KB
- Stars: 69
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magic Bean
A very basic library which will generate getters and setters.
Requires Java 21+.
### Maven
```xml
dev.mccue
magic-bean
2024.04.26
provided
```
### Gradle
```
dependencies {
compileOnly("dev.mccue:magic-bean:2024.04.26")
annotationProcessor("dev.mccue:magic-bean:2024.04.26")
}
```
## What this does
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
1. Boilerplate reduction for code that needs "dumb" POJOs
2. Demonstrate that annotation processors and source code
generation aren't that scary
3. Cover some of the use cases of [lombok](https://projectlombok.org/) without
[the compiler hacking it does](https://github.com/projectlombok/lombok/issues/2681)
The non-goals of this library are
1. To provide a tool which fits all use cases. (conflicts with goal #2)
2. Provide a way to generate immutable value objects. Use [records](https://dev.java/learn/using-record-to-model-immutable-data/),
[immutables](https://immutables.github.io/), or elbow grease for that.
3. Support old Java versions.
## Usage
### Basic Example
#### I receive
```java
import dev.mccue.magicbean.MagicBean;
import java.util.List;
@MagicBean
public final class Example extends ExampleBeanOps {
int x;
String name;
List strs;
}
```
#### You receive
```java
sealed abstract class ExampleBeanOps extends java.lang.Object permits Example {
private Example self() {
return (switch (this) { case Example __ -> __; });
}
/**
* Get the current value for x.
*/
public int getX() {
return self().x;
}
/**
* Set the current value for x.
*/
public void setX(int x) {
self().x = x;
}
/**
* Get the current value for name.
*/
public java.lang.String getName() {
return self().name;
}
/**
* Set the current value for name.
*/
public void setName(java.lang.String name) {
self().name = name;
}
/**
* Get the current value for strs.
*/
public java.util.List getStrs() {
return self().strs;
}
/**
* Set the current value for strs.
*/
public void setStrs(java.util.List strs) {
self().strs = strs;
}
}
```
### Complete Example
#### I receive
```java
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 strs;
}
```
#### You receive
```java
sealed abstract class ExampleBeanOps extends java.lang.Object permits Example {
private Example self() {
return (switch (this) { case Example __ -> __; });
}
/**
* Creates an instance of Example.
*/
public static Example of(
int x,
java.lang.String name,
java.util.List 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 self().x;
}
/**
* Set the current value for x.
*/
public void setX(int x) {
self().x = x;
}
/**
* Get the current value for name.
*/
public java.lang.String getName() {
return self().name;
}
/**
* Set the current value for name.
*/
public void setName(java.lang.String name) {
self().name = name;
}
/**
* Get the current value for strs.
*/
public java.util.List getStrs() {
return self().strs;
}
/**
* Set the current value for strs.
*/
public void setStrs(java.util.List strs) {
self().strs = strs;
}
@Override
public boolean equals(Object o) {
if (o == null || !(o instanceof Example other)) {
return false;
}
else {
return java.util.Objects.equals(self().x, other.x) &&
java.util.Objects.equals(self().name, other.name) &&
java.util.Objects.equals(self().strs, other.strs);
}
}
@Override
public int hashCode() {
return java.util.Objects.hash(
self().x,
self().name,
self().strs
);
}
@Override
public String toString() {
return "Example[" + "x=" + self().x +
", " + "name=" + self().name +
", " + "strs=" + self().strs + "]";
}
}
```
## Usage with frameworks
### [JPA / Hibernate](./usage/jpa.md)
### [Rife2](./usage/rife2.md)
## Customizing
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.