Package org.apache.juneau.bean.jsonschema

Class JsonSchemaBeanGenerator

java.lang.Object

org.apache.juneau.bean.jsonschema.JsonSchemaBeanGenerator

public final class JsonSchemaBeanGenerator
extends Object

Bridge for generating typed JsonSchema beans from Java types.

JsonSchemaGenerator in juneau-marshall produces JsonMap output. This class wraps that generator and converts the generated map into typed JsonSchema beans in juneau-bean-jsonschema.

Example:

// Default generation. JsonSchema s1 = JsonSchemaBeanGenerator.DEFAULT.generate(MyBean.class); // Custom generation with bean defs and descriptions. JsonSchema s2 = JsonSchemaBeanGenerator.create() .useBeanDefs() .addDescriptionsTo(TypeCategory.ANY) .build() .generate(MyBean.class);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JsonSchemaBeanGenerator.Builder	Builder for JsonSchemaBeanGenerator.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonSchemaBeanGenerator	DEFAULT	Reusable default instance.

Method Summary

Modifier and Type	Method	Description
static JsonSchemaBeanGenerator.Builder	create()	Creates a new builder.
JsonSchema<?>	generate(Class<?> type)	Generates a schema bean from a Java class.
JsonSchema<?>	generate(Object o)	Generates a schema bean from an object.
JsonSchema<?>	generate(Type type)	Generates a schema bean from a Java type.
static JsonSchema<?>	toBean(JsonMap schemaMap)	Converts a generated schema map into a typed bean.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final JsonSchemaBeanGenerator DEFAULT

Reusable default instance.

Method Details

create

public static JsonSchemaBeanGenerator.Builder create()

Creates a new builder.

generate

public JsonSchema<?> generate(Type type)

Generates a schema bean from a Java type.

Parameters:

type - The Java type. Must not be null, or an IllegalArgumentException is thrown.

Returns:

The generated schema bean, or null if a schema could not be generated for the type.

generate

public JsonSchema<?> generate(Class<?> type)

Generates a schema bean from a Java class.

Parameters:

type - The Java class. Must not be null, or an IllegalArgumentException is thrown.

Returns:

The generated schema bean, or null if a schema could not be generated for the class.

generate

public JsonSchema<?> generate(Object o)

Generates a schema bean from an object.

The value can be a POJO or a Class/Type.

Parameters:

o - The value to infer a schema from. Must not be null, or an IllegalArgumentException is thrown.

Returns:

The generated schema bean, or null if a schema could not be generated for the value.

toBean

public static JsonSchema<?> toBean(JsonMap schemaMap)

Converts a generated schema map into a typed bean.

Conversion uses a JSON roundtrip to ensure the swaps declared on JsonSchema are honored.

Parameters:

schemaMap - The generated schema map. Must not be null, or an IllegalArgumentException is thrown.

Returns:

The typed schema bean.