Package com.github.victools.jsonschema.generator

Interface CustomDefinitionProviderV2

All Superinterfaces:

StatefulConfig

All Known Subinterfaces:

CustomDefinitionProvider

All Known Implementing Classes:

InlineSchemaModule

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CustomDefinitionProviderV2
extends StatefulConfig

Provider of non-standard JSON schema definitions.

Method Summary

Modifier and Type	Method	Description
CustomDefinition	provideCustomSchemaDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)	Look-up the non-standard JSON schema definition for a given type.

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

resetAfterSchemaGenerationFinished

Method Details

provideCustomSchemaDefinition

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

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.

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)