Package com.github.victools.jsonschema.generator.impl.module

Class InlineSchemaModule

java.lang.Object

com.github.victools.jsonschema.generator.impl.module.InlineSchemaModule

All Implemented Interfaces:

CustomDefinitionProviderV2, Module, StatefulConfig

public class InlineSchemaModule
extends Object
implements Module, CustomDefinitionProviderV2

Default module being included if Option.INLINE_ALL_SCHEMAS is enabled.

Constructor Summary

Constructors

Constructor	Description
InlineSchemaModule()

Method Summary

Modifier and Type	Method	Description
void	applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)	Apply this module to the given configuration builder instance.
CustomDefinition	provideCustomSchemaDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)	Look-up the non-standard JSON schema definition for a given type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.victools.jsonschema.generator.StatefulConfig

resetAfterSchemaGenerationFinished

Constructor Details

InlineSchemaModule

public InlineSchemaModule()

Method Details

applyToConfigBuilder

public void applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)

Description copied from interface: Module

Apply this module to the given configuration builder instance.

Specified by:

applyToConfigBuilder in interface Module

Parameters:

builder - configuration builder instance to which to apply this module

provideCustomSchemaDefinition

public CustomDefinition provideCustomSchemaDefinition(com.fasterxml.classmate.ResolvedType javaType,
 SchemaGenerationContext context)

Description copied from interface: CustomDefinitionProviderV2

Look-up the non-standard JSON schema definition for a given type. If it returns null, the next definition provider is expected to be applied.

Specified by:

provideCustomSchemaDefinition in interface CustomDefinitionProviderV2

Parameters:

javaType - generic type to provide custom definition for

context - generation context allowing to let the standard generation take over nested parts of the custom definition

Returns:

non-standard JSON schema definition (may be null)