io.vertx.codegen.json.annotations

Annotation Type JsonGen

public @interface JsonGen

Annotation for DataObject annotated class that triggers the generation of a converter class that performs from/to JSON conversion based on the data object properties.

The name of this converter is the name of the data object with the Converter suffix.

The converter has a fromJson(JsonObject,T) and a toJson(T,JsonObject) public static methods, such methods can be used by the json constructor or the toJson() method to implement the conversion code.

By default, the generated methods only handle the conversion of the property of the data object and do not handle the properties of the ancestors of this data object, inheritConverter() can be set to true to change this behavior and handle the conversion of the inherited properties as well.

Author:

Julien Viet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	base64Type Returns the expected Base64 (RFC 4648) type to be used.
boolean	inheritConverter
Class<? extends Case>	jsonPropertyNameFormatter
boolean	publicConverter

Element Detail

inheritConverter

public abstract boolean inheritConverter

Returns:

true if the converter should handle the state of the ancestors.

Default:

false

publicConverter

public abstract boolean publicConverter

Returns:

whether the generated converter should be public or package private

Default:

true

jsonPropertyNameFormatter

public abstract Class<? extends Case> jsonPropertyNameFormatter

Returns:

todo

Default:

io.vertx.codegen.format.LowerCamelCase.class

base64Type

public abstract String base64Type

Returns the expected Base64 (RFC 4648) type to be used. When omitted, his is vert.x default alphabet, usually (RFC 4648 Table 2) also known as base64url, unless the system property vertx.json.base64 is legacy. In this case the alphabet will be basic as it was during the vert.x 3.x releases. Allowed values are:

• "base64url" - Base64 URL and Filename Safe as defined in (RFC 4648 Table 2)
• "basic" - Base64 Basic as defined in (RFC 4648 Table 1)

Returns:

if generated converters are enabled, buffers should default to the configured type.

Default:

""