Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arey/javabean-marshaller
Serialize an object graph to it's Java code
https://github.com/arey/javabean-marshaller
Last synced: 2 months ago
JSON representation
Serialize an object graph to it's Java code
- Host: GitHub
- URL: https://github.com/arey/javabean-marshaller
- Owner: arey
- License: apache-2.0
- Created: 2016-03-05T09:37:29.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-07T08:11:45.000Z (about 1 year ago)
- Last Synced: 2024-10-12T12:46:29.919Z (3 months ago)
- Language: Java
- Size: 141 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.html
Awesome Lists containing this project
README
# JavaBean Marshaller #
The **JavaBeanMarshaller utility class** is responsible for **serializing an object (graph) to it's Java code**.
The objects from the graph have to follow the **JavaBean convention**.
And by Java code, we talk calling getters and setters of all the object graph.
The main purpose of this tools is to help developer to create realistic data sets or stubs for their unit tests.
Instead of using XML or JSON serialization, dataset are generated into the Java language. This format is more appropriate for performance and refactoring purpose.
## Supports ##
* Primitive types and their wrapper classes
* Enumeration
* Collection and Map
* Arrays (1 and 2 dimensions)
* java.util.Date, java.sql.Date, Calendar, XMLGregorianCalendar
* Java 8 Date & Time API (JSR-310)
* JodaTime
* Unidirectional and bidirectionnal relationships
* Cyclic graph
## Example ##
Let's imagine an in memory artist instance with a single album.
Call the ```generateJavaCode``` method:
```
JavaBeanMarshaller.generateJavaCode(artist);
```
At the working directory, the java class _ArtistFactory.java_ is generated:
```
import com.javaetmoi.javabean.domain.Album;
import com.javaetmoi.javabean.domain.Artist;
import com.javaetmoi.javabean.domain.ArtistType;
import java.time.LocalDate;
import java.time.Month;
import java.util.ArrayList;
public class ArtistFactory {
public static Artist newArtist() {
Artist artist1 = new Artist();
ArrayList albums1 = new ArrayList<>();
Album album1 = new Album();
album1.setArtist(artist1);
album1.setReleaseDate(LocalDate.of(1987, Month.MARCH, 9));
album1.setName("The Joshua Tree");
albums1.add(album1);
artist1.setAlbums(albums1);
artist1.setName("U2");
artist1.setId(1L);
artist1.setType(ArtistType.GROUP);
return artist1;
}
}
```
## Pre-requisites ##
* Java 7 or above
* Your JavaBeans should have of a no-arg constructors and getter/setter
## Quick Start ##
Download the jar though Maven:
```xml
com.javaetmoi.util
javaetmoi-javabean-marshaller
1.0.3
```
JavaBean Marshaller artefacts are available from [Maven Central](http://repo1.maven.org/maven2/com/javaetmoi/util/javaetmoi-javabean-marshaller/)
[](https://maven-badges.herokuapp.com/maven-central/com.javaetmoi.util/javaetmoi-javabean-marshaller)
In your application code, select a point o add the ```generateJavaCode``` method call:
```
JavaBeanMarshaller.generateJavaCode(myBean);
```
Run your application and play the scenario.
To support a new custome type, you have to implement the ```CodeGenerator``` interface then call the ```JavaBeanMarshaller::addCodeGenerator``` method.
## Getting Help ##
This readme.md file contains the main documentation.
There are also unit tests available to look at.
A french article titled *Génération de jeux de données Java* : http://javaetmoi.com/2016/03/generation-jeux-donnees-java/
## Contributing to JavaBean Marshaller ##
Github is for social coding platform: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/articles/fork-a-repo/). If you want to contribute code this way, please reference a GitHub ticket as well covering the specific issue you are addressing.
Before submitting your pull request, don't forget to write a corresponding unit test.
### Development environment installation ###
Download the code with git:
``git clone git://github.com/arey/javabean-marshaller.git``
Compile the code with maven:
``mvn clean install``
If you're using an IDE that supports Maven-based projects (InteliJ Idea, Netbeans or m2Eclipse), you can import the project directly from its POM.
Otherwise, generate IDE metadata with the related IDE maven plugin:
``mvn eclipse:clean eclipse:eclipse``
## Release Note ##
| Version | Release Date | Features |
|---------|--------------|---------------------------------------|
| 1.0.3 | 2018-07-11 | Escape double quotes in String |
| 1.0.2 | 2017-12-22 | Add BigInteger support |
| 1.0.1 | 2016-03-23 | Enhance quality of the generated code |
| 1.0.0 | 2016-03-19 | Initial release |
## Credits ##
* [Javapoet](https://github.com/square/javapoet) from Square and [Apache Common BeanUtils](https://commons.apache.org/proper/commons-beanutils/)
* Uses [Maven](http://maven.apache.org/) as a build tool
* Uses [Travis CI](http://www.travis-ci.org) for continuous integration builds whenever code is pushed into GitHub
## Build Status ##
* Travis: [](https://travis-ci.org/arey/javabean-marshaller)
* Coverage [](https://coveralls.io/github/arey/javabean-marshaller?branch=master)