Deep Initializer

Initialize deep bean recursively filling with default values.

License

License

GroupId

GroupId

io.github.konohiroaki
ArtifactId

ArtifactId

deep-initializer
Last Version

Last Version

1.0.0
Release Date

Release Date

Type

Type

jar
Description

Description

Deep Initializer
Initialize deep bean recursively filling with default values.
Project URL

Project URL

https://github.com/konohiroaki/deep-initializer
Source Code Management

Source Code Management

http://github.com/konohiroaki/deep-initializer/tree/master

Download deep-initializer

How to add to project

<!-- https://jarcasting.com/artifacts/io.github.konohiroaki/deep-initializer/ -->
<dependency>
    <groupId>io.github.konohiroaki</groupId>
    <artifactId>deep-initializer</artifactId>
    <version>1.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/io.github.konohiroaki/deep-initializer/
implementation 'io.github.konohiroaki:deep-initializer:1.0.0'
// https://jarcasting.com/artifacts/io.github.konohiroaki/deep-initializer/
implementation ("io.github.konohiroaki:deep-initializer:1.0.0")
'io.github.konohiroaki:deep-initializer:jar:1.0.0'
<dependency org="io.github.konohiroaki" name="deep-initializer" rev="1.0.0">
  <artifact name="deep-initializer" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.github.konohiroaki', module='deep-initializer', version='1.0.0')
)
libraryDependencies += "io.github.konohiroaki" % "deep-initializer" % "1.0.0"
[io.github.konohiroaki/deep-initializer "1.0.0"]

Dependencies

test (2)

Group / Artifact Type Version
junit : junit jar 4.12
org.hamcrest : hamcrest-all jar 1.3

Project Modules

There are no modules declared in this project.

Deep Initializer

[Maven Central](http://search.maven.org/#search|ga|1|g:io.github.konohiroaki AND a:deep-initializer-*!parent) license

Build Status Coverage Status

Initialize deep bean recursively with customizable initializers.

======= A.java
class A {
    int num;
}

======= B.java
class B extends A {
    boolean bool;
    C c;
}

======= C.java
class C {
    String str;
}

======= Main.java
public static void main(String[] args) {
    B b = new DeepInitializer().init(B.class);

    System.out.println(b.num); // ==> 0
    System.out.println(b.bool); // ==> false
    System.out.println(b.c.str); // ==> ""
}

When do you want to use it?

This might be helpful when you want to test an API which requires deep bean for calling it.

Creating deep beans for those APIs by manually writing Java code like this

SomeApiRequest rq = new SomeApiRequest();
rq.setA(true);
rq.setB(new B());
rq.getB().setC(10);
rq.getB().setD("Hello");
...more and more sets

is so much waste of time. Rather than doing that, let's do this.

SomeApiRequest rq = new DeepInitializer().init(SomeApiRequest.class);

You can instantly build a deep bean. The way how it initializes a bean depends on the initializers you use. Yes, you can create your custom initializer for specific types!

Specification

There are two kinds of initalizers, "type initializer" and "field initializer". Type initializer only refers its type information to decide its value. Field initializer refers the field information thus you can get some more information than type initializer. So these two are not that different, and if there's no field initializer for a type, it fallbacks to its type initializer.

The parameter you pass to DeepInitializer#init(Class) is just a type thus it cannot refer any field information. But the fields declared in that type can refer its field information.

Default initializer

Default initializers are set when you new DeepInitializer(). You cannot remove default initializers but you can add your custom initializers and that will be prioritized than the default ones.

Type Initializer

Type Value
Primitive Types Its default value defined in JLS
Primitive Wrapper Types Refers its primitive type's default value
String ""
Enum EnumType.values()[0]
List or its derived type new ArrayList<>()
Set or its derived type new HashSet<>()
Map or its derived type new HashMap<>()
Others new OtherType() and fills its fields with the field default initializer

Field Initializer

There is no default field initializers. It only refers type information by default.

Custom initializer

The initialization behaviour is fully customizable. You can add your custom initializers to change the behaviour of each initialization. To do so, extend BaseTypeInitializer<> or BaseFieldInitializer<>.

class ExamplePojo {
    @CustomAnnotation("Hello World!")
    String str1;
    String str2;
}

@Retention(RetentionPolicy.RUNTIME)
@interface CustomAnnotation {
    String value();
}

class CustomStringTypeInitializer extends BaseTypeInitializer<String> {
    @Override public String init(Class<String> clazz) {
        return "DEFAULT";
    }
}

class CustomStringFieldInitializer extends BaseFieldInitializer<String> {
    @Override public String init(Field field) {
        CustomAnnotation annotation = field.getAnnotation(CustomAnnotation.class);
        if (annotation != null && annotation.value() != null) {
            return annotation.value();
        }
        return new CustomStringTypeInitializer().init(String.class);
    }
}

@Test
public void test() {
    DeepInitializer deep = new DeepInitializer();

    deep.addTypeInitializer(String.class, new CustomStringTypeInitializer());
    System.out.println(deep.init(String.class));           // ==> "DEFAULT"
    // Custom initializer takes priority than the default. (Specifically, later added has higher priority)

    deep.addFieldInitializer(String.class, new CustomStringFieldInitializer());
    System.out.println(deep.init(ExamplePojo.class).str1); // ==> "Hello World!"
    System.out.println(deep.init(ExamplePojo.class).str2); // ==> "DEFAULT"

    deep.removeFieldInitializer(String.class);
    System.out.println(deep.init(ExamplePojo.class).str1); // ==> "DEFAULT"
    System.out.println(deep.init(ExamplePojo.class).str2); // ==> "DEFAULT"

    deep.removeTypeInitializer(String.class);
    // You cannot remove Default initializers.
    System.out.println(deep.init(ExamplePojo.class).str1); // ==> ""
    System.out.println(deep.init(ExamplePojo.class).str2); // ==> ""
}

Contribute

For any bug reports, enhancement requests, or code patches, please use the GitHub Issue system.

Versions

Version
1.0.0
0.2.0
0.1.0