Package org.apache.juneau.jsonschema

Class JsonSchemaGenerator

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.jsonschema.JsonSchemaGenerator

All Implemented Interfaces:

JsonSchemaMetaProvider

public class JsonSchemaGenerator
extends BeanTraverseContext
implements JsonSchemaMetaProvider

Generates JSON-schema metadata about POJOs.

Notes:

• This class is thread safe and reusable.

See Also:

• JSON-Schema Support

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonSchemaGenerator.Builder	Builder class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<TypeCategory>	addDescriptionsTo
protected final Set<TypeCategory>	addExamplesTo
protected final boolean	allowNestedDescriptions
protected final boolean	allowNestedExamples
protected final Class<? extends BeanDefMapper>	beanDefMapper
static final JsonSchemaGenerator	DEFAULT	Default serializer, all default settings.
protected final Set<String>	ignoreTypes
protected final JsonParser	jsonParser
protected final JsonSerializer	jsonSerializer
protected final boolean	useBeanDefs

Fields inherited from class org.apache.juneau.BeanContextable

beanContext

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
JsonSchemaGenerator(JsonSchemaGenerator.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
JsonSchemaGenerator.Builder	copy()	Creates a builder from this context object.
static JsonSchemaGenerator.Builder	create()	Creates a new builder for this object.
JsonSchemaGeneratorSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
protected final Set<TypeCategory>	getAddDescriptionsTo()	Add descriptions to types.
protected final Set<TypeCategory>	getAddExamplesTo()	Add examples.
protected final BeanDefMapper	getBeanDefMapper()	Bean schema definition mapper.
List<Pattern>	getIgnoreTypes()	Ignore types from schema definitions.
JsonSchemaBeanPropertyMeta	getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
JsonSchemaClassMeta	getJsonSchemaClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
JsonSchemaGeneratorSession	getSession()	Returns a session to use for this context.
protected final boolean	isAllowNestedDescriptions()	Allow nested descriptions.
protected final boolean	isAllowNestedExamples()	Allow nested examples.
boolean	isIgnoredType(ClassMeta<?> cm)	Returns true if the specified type is ignored.
protected final boolean	isUseBeanDefs()	Use bean definitions.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.

Methods inherited from class org.apache.juneau.BeanTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final JsonSchemaGenerator DEFAULT

Default serializer, all default settings.

allowNestedDescriptions

protected final boolean allowNestedDescriptions

allowNestedExamples

protected final boolean allowNestedExamples

useBeanDefs

protected final boolean useBeanDefs

beanDefMapper

protected final Class<? extends BeanDefMapper> beanDefMapper

jsonParser

protected final JsonParser jsonParser

jsonSerializer

protected final JsonSerializer jsonSerializer

addDescriptionsTo

protected final Set<TypeCategory> addDescriptionsTo

addExamplesTo

protected final Set<TypeCategory> addExamplesTo

ignoreTypes

protected final Set<String> ignoreTypes

Constructor Details

JsonSchemaGenerator

public JsonSchemaGenerator(JsonSchemaGenerator.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static JsonSchemaGenerator.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public JsonSchemaGenerator.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Specified by:

copy in class BeanTraverseContext

Returns:

A new Builder object.

createSession

public JsonSchemaGeneratorSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class Context

Returns:

A new session builder.

getIgnoreTypes

public List<Pattern> getIgnoreTypes()

Ignore types from schema definitions.

Returns:

Custom schema information for particular class types.
Never null.
List is unmodifiable.

See Also:

• JsonSchemaGenerator.Builder.ignoreTypes(String...)

getJsonSchemaBeanPropertyMeta

public JsonSchemaBeanPropertyMeta getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: JsonSchemaMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getJsonSchemaBeanPropertyMeta in interface JsonSchemaMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getJsonSchemaClassMeta

public JsonSchemaClassMeta getJsonSchemaClassMeta(ClassMeta<?> cm)

Description copied from interface: JsonSchemaMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getJsonSchemaClassMeta in interface JsonSchemaMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getSession

public JsonSchemaGeneratorSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class Context

Returns:

A new session object.

isIgnoredType

public boolean isIgnoredType(ClassMeta<?> cm)

Returns true if the specified type is ignored.

The type is ignored if it's specified in the JsonSchemaGenerator.Builder.ignoreTypes(String...) setting.
Ignored types return null on the call to JsonSchemaGeneratorSession.getSchema(ClassMeta).

Parameters:

cm - The type to check.

Returns:

true if the specified type is ignored.

getAddDescriptionsTo

protected final Set<TypeCategory> getAddDescriptionsTo()

Add descriptions to types.

Returns:

Set of categories of types that descriptions should be automatically added to generated schemas.

See Also:

• JsonSchemaGenerator.Builder.addDescriptionsTo(TypeCategory...)

getAddExamplesTo

protected final Set<TypeCategory> getAddExamplesTo()

Add examples.

Returns:

Set of categories of types that examples should be automatically added to generated schemas.

See Also:

• JsonSchemaGenerator.Builder.addExamplesTo(TypeCategory...)

getBeanDefMapper

protected final BeanDefMapper getBeanDefMapper()

Bean schema definition mapper.

Returns:

Interface to use for converting Bean classes to definition IDs and URIs.

See Also:

• JsonSchemaGenerator.Builder.beanDefMapper(Class)

isAllowNestedDescriptions

protected final boolean isAllowNestedDescriptions()

Allow nested descriptions.

Returns:

true if nested descriptions are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder.allowNestedDescriptions()

isAllowNestedExamples

protected final boolean isAllowNestedExamples()

Allow nested examples.

Returns:

true if nested examples are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder.allowNestedExamples()

isUseBeanDefs

protected final boolean isUseBeanDefs()

Use bean definitions.

Returns:

true if schemas on beans will be serialized with '$ref' tags.

See Also:

• JsonSchemaGenerator.Builder.useBeanDefs()

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class BeanTraverseContext

Returns:

The properties on this bean as a map for debugging.