Skip to content

README.md

Latest commit

 

History

History
65 lines (51 loc) · 1.94 KB

README.md

File metadata and controls

65 lines (51 loc) · 1.94 KB

Graal Reflection Configuration Generator provides an easy way to geenrate GraalVM reflection config files, configure the plugin on your gradle project, annotate the desired class class with @Reflection run the gradle build then you're done.

See an example app

Using

Gradle dependencies

dependencies {
  compileOnly("com.mageddo.nativeimage:reflection-config-generator:2.3.4")
  annotationProcessor("com.mageddo.nativeimage:reflection-config-generator:2.3.4")
}

Consider the following example

package com.acme;

import nativeimage.Reflection;

@Reflection(declaredConstructors = true, declaredFields = true)
public class Fruit {
  private String name;
  private String color;   
}

it will automatically configure reflection for Fruit props when compiling using native-image generating a json like

[
  {
    "name" : "com.acme.Fruit",
    "allDeclaredConstructors" : true,
    "allPublicConstructors" : false,
    "allDeclaredMethods" : false,
    "allPublicMethods" : false,
    "allPublicFields" : false,
    "allDeclaredFields" : true
  }
]

Generation reflection to external library jars

As annotation processing only can process source code, if you need to generate a reflection json file to an external jar, you can do as follows:

Download reflection-config-generator latest release jar then run something like:

$ java -cp "your.jar:reflection-config-generator.jar" nativeimage.core.thirdparty.Main com.acme /tmp/tmp.json

generating reflect..., package=com.acme,  options=[com.github.dockerjava.api.model, /tmp/tmp.json]
generated!, package=com.acme, objects=148, writtenTo=/tmp/tmp.json

See available options by running

$ java -jar reflection-config-generator.jar --help