A C F G J L P R S V

A

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.module.jackson.JacksonModule

C

com.github.victools.jsonschema.module.jackson - package com.github.victools.jsonschema.module.jackson

CustomEnumDefinitionProvider - Class in com.github.victools.jsonschema.module.jackson

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 and/or JsonProperty annotations being present on all enum constants.

CustomEnumDefinitionProvider(boolean, boolean) - Constructor for class com.github.victools.jsonschema.module.jackson.CustomEnumDefinitionProvider

Constructor indicating how to attempt to serialise enum constant values.

F

findSubtypes(ResolvedType, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.module.jackson.JsonSubTypesResolver

findTargetTypeOverrides(MemberScope<?, ?>) - Method in class com.github.victools.jsonschema.module.jackson.JsonSubTypesResolver

Look-up applicable subtypes for the given field/method if there is a JsonSubTypes annotation.

G

getBeanDescriptionForClass(ResolvedType) - Method in class com.github.victools.jsonschema.module.jackson.JacksonModule

Create a jackson BeanDescription for the given type's erased class in order to avoid having to re-create the complexity therein.

getJsonValueAnnotatedMethod(ResolvedType, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.module.jackson.CustomEnumDefinitionProvider

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

getPropertyNameOverride(FieldScope) - Method in class com.github.victools.jsonschema.module.jackson.JacksonModule

Look-up an alternative name as per the following order of priority.

getSerializedValuesFromJsonProperty(ResolvedType, Object[]) - Method in class com.github.victools.jsonschema.module.jackson.CustomEnumDefinitionProvider

Check whether the given type is an enum with at least one constant value and each enum constant value has a JsonProperty annotation.

getSerializedValuesFromJsonValue(ResolvedType, Object[], SchemaGenerationContext) - Method in class com.github.victools.jsonschema.module.jackson.CustomEnumDefinitionProvider

Check whether the given type is an enum with at least one constant value and a single JsonValue annotated method with value = true and no expected arguments.

J

JacksonModule - Class in com.github.victools.jsonschema.module.jackson

Module for setting up schema generation aspects based on jackson-annotations: Populate the "description" attributes as per JsonPropertyDescription and JsonClassDescription annotations. Apply alternative property names defined in JsonProperty annotations. Exclude properties that are deemed to be ignored per the various annotations for that purpose. Optionally: treat enum types as plain strings as per JsonValue annotations.

JacksonModule() - Constructor for class com.github.victools.jsonschema.module.jackson.JacksonModule

Constructor, without any additional options.

JacksonModule(JacksonOption...) - Constructor for class com.github.victools.jsonschema.module.jackson.JacksonModule

Constructor.

JacksonOption - Enum in com.github.victools.jsonschema.module.jackson

Flags to enable/disable certain aspects of the JacksonModule's processing.

JsonSubTypesResolver - Class in com.github.victools.jsonschema.module.jackson

Look-up of subtypes from a JsonSubTypes annotation.

JsonSubTypesResolver() - Constructor for class com.github.victools.jsonschema.module.jackson.JsonSubTypesResolver

L

lookUpSubtypesFromAnnotation(ResolvedType, JsonSubTypes, TypeContext) - Method in class com.github.victools.jsonschema.module.jackson.JsonSubTypesResolver

Mapping the declared erased types from the annotation to resolved types.

P

provideCustomPropertySchemaDefinition(MemberScope<?, ?>, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.module.jackson.JsonSubTypesResolver

Providing custom schema definition for field/method in case of a per-property override of the applicable subtypes or how they are serialized.

provideCustomSchemaDefinition(ResolvedType, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.module.jackson.CustomEnumDefinitionProvider

provideCustomSchemaDefinition(ResolvedType, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.module.jackson.JsonSubTypesResolver

R

resolveDescription(FieldScope) - Method in class com.github.victools.jsonschema.module.jackson.JacksonModule

Determine the given type's associated "description" in the following order of priority.

resolveDescriptionForType(TypeScope) - Method in class com.github.victools.jsonschema.module.jackson.JacksonModule

Determine the given type's associated "description" via the following annotation.

S

shouldIgnoreField(FieldScope) - Method in class com.github.victools.jsonschema.module.jackson.JacksonModule

Determine whether a given field should be ignored, according to various jackson annotations for that purpose,
e.g.

V

valueOf(String) - Static method in enum com.github.victools.jsonschema.module.jackson.JacksonOption

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.victools.jsonschema.module.jackson.JacksonOption

Returns an array containing the constants of this enum type, in the order they are declared.

A C F G J L P R S V