com.github.victools.jsonschema.module.jackson

Class CustomEnumJsonValueDefinitionProvider

java.lang.Object

com.github.victools.jsonschema.module.jackson.CustomEnumJsonValueDefinitionProvider

All Implemented Interfaces:

CustomDefinitionProviderV2

public class CustomEnumJsonValueDefinitionProvider
extends Object
implements CustomDefinitionProviderV2

Implementation of the CustomDefinitionProviderV2 interface for treating enum types as plain strings based on a JsonValue annotation being present with value = true on exactly one argument-free method. If no such annotation exists, no custom definition will be returned; thereby falling back on whatever is defined in a following custom definition (e.g. from one of the standard generator Options).

Constructor Summary

Constructors

Constructor and Description
CustomEnumJsonValueDefinitionProvider()

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.classmate.members.ResolvedMethod	getJsonValueAnnotatedMethod(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context) Look-up the single JsonValue annotated method with value = true and no expected arguments.
CustomDefinition	provideCustomSchemaDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomEnumJsonValueDefinitionProvider

public CustomEnumJsonValueDefinitionProvider()

Method Detail

provideCustomSchemaDefinition

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

Specified by:

provideCustomSchemaDefinition in interface CustomDefinitionProviderV2

getJsonValueAnnotatedMethod

protected com.fasterxml.classmate.members.ResolvedMethod getJsonValueAnnotatedMethod(com.fasterxml.classmate.ResolvedType javaType,
                                                                                     SchemaGenerationContext context)

Look-up the single JsonValue annotated method with value = true and no expected arguments.

Parameters:

javaType - targeted type to look-up serialization method for

context - generation context providing access to type resolution context

Returns:

single method with JsonValue annotation