com.github.victools.jsonschema.module.jackson

Class JacksonModule

java.lang.Object

com.github.victools.jsonschema.module.jackson.JacksonModule

All Implemented Interfaces:

com.github.victools.jsonschema.generator.Module

public class JacksonModule
extends Object
implements com.github.victools.jsonschema.generator.Module

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.

Constructor Summary

Constructors

Constructor and Description
JacksonModule()

Method Summary

Modifier and Type	Method and Description
void	applyToConfigBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder builder)
protected <A extends Annotation> A	getAnnotationFromFieldOrGetter(com.github.victools.jsonschema.generator.FieldScope field, Class<A> annotationClass) Retrieves the annotation instance of the given type, either from the field it self or (if not present) from its getter.
protected com.fasterxml.jackson.databind.BeanDescription	getBeanDescriptionForClass(com.fasterxml.classmate.ResolvedType targetType) Create a jackson BeanDescription for the given type's erased class in order to avoid having to re-create the complexity therein.
protected String	getPropertyNameOverride(com.github.victools.jsonschema.generator.FieldScope field) Look-up an alternative name as per the following order of priority.
protected String	resolveDescription(com.github.victools.jsonschema.generator.FieldScope field) Determine the given type's associated "description" in the following order of priority.
protected boolean	shouldIgnoreField(com.github.victools.jsonschema.generator.FieldScope field) Determine whether a given field should be ignored, according to various jackson annotations for that purpose, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonModule

public JacksonModule()

Method Detail

applyToConfigBuilder

public void applyToConfigBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder builder)

Specified by:

applyToConfigBuilder in interface com.github.victools.jsonschema.generator.Module

getAnnotationFromFieldOrGetter

protected <A extends Annotation> A getAnnotationFromFieldOrGetter(com.github.victools.jsonschema.generator.FieldScope field,
                                                                  Class<A> annotationClass)

Retrieves the annotation instance of the given type, either from the field it self or (if not present) from its getter.

Type Parameters:

A - type of annotation

Parameters:

field - field to retrieve annotation instance from (or from its getter)

annotationClass - type of annotation

Returns:

annotation instance (or null)

See Also:

MemberScope.getAnnotation(Class), FieldScope.findGetter()

resolveDescription

protected String resolveDescription(com.github.victools.jsonschema.generator.FieldScope field)

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

1. JsonPropertyDescription annotation on the field itself
2. JsonPropertyDescription annotation on the field's getter method
3. JsonClassDescription annotation on the field's type

Parameters:

field - field for which to collect an available description

Returns:

successfully looked-up description (or null)

getPropertyNameOverride

protected String getPropertyNameOverride(com.github.victools.jsonschema.generator.FieldScope field)

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

1. JsonProperty annotation on the field itself
2. JsonProperty annotation on the field's getter method

Parameters:

field - field to look-up alternative property name for

Returns:

alternative property name (or null)

getBeanDescriptionForClass

protected final com.fasterxml.jackson.databind.BeanDescription getBeanDescriptionForClass(com.fasterxml.classmate.ResolvedType targetType)

Create a jackson BeanDescription for the given type's erased class in order to avoid having to re-create the complexity therein.
This is assumed to have a negative performance impact (as one type is being introspected twice), that should be fine for schema generation.

Parameters:

targetType - type for whose erased class the BeanDescription should be created

Returns:

introspection result of given type's erased class

shouldIgnoreField

protected boolean shouldIgnoreField(com.github.victools.jsonschema.generator.FieldScope field)

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

Parameters:

field - field to check

Returns:

whether field should be excluded