io.swagger.v3.core.jackson

Class ModelResolver

java.lang.Object

io.swagger.v3.core.jackson.AbstractModelConverter

io.swagger.v3.core.jackson.ModelResolver

All Implemented Interfaces:

ModelConverter

public class ModelResolver
extends AbstractModelConverter
implements ModelConverter

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	composedModelPropertiesAsSibling
static boolean	enumsAsRef Allows all enums to be resolved as a reference to a scheme added to the components section.
static List<String>	NOT_NULL_ANNOTATIONS
static String	SET_PROPERTY_OF_COMPOSED_MODEL_AS_SIBLING
static String	SET_PROPERTY_OF_ENUMS_AS_REF

Fields inherited from class io.swagger.v3.core.jackson.AbstractModelConverter

_intr, _mapper, _resolvedTypeNames, _typeNameResolver

Constructor Summary

Constructors

Constructor and Description
ModelResolver(com.fasterxml.jackson.databind.ObjectMapper mapper)
ModelResolver(com.fasterxml.jackson.databind.ObjectMapper mapper, TypeNameResolver typeNameResolver)

Method Summary

Modifier and Type	Method and Description
protected void	_addEnumProps(Class<?> propClass, Schema property)
protected boolean	_isOptionalType(com.fasterxml.jackson.databind.JavaType propType)
protected void	addRequiredItem(Schema model, String propName)
protected void	applyBeanValidatorAnnotations(Schema property, Annotation[] annotations, Schema parent)
protected String	decorateModelName(AnnotatedType type, String originalName) Decorate the name based on the JsonView
protected Type	findJsonValueType(com.fasterxml.jackson.databind.BeanDescription beanDesc)
protected List<Class<?>>	getComposedSchemaReferencedClasses(Class<?> clazz, Annotation[] ctxAnnotations, Schema schemaAnnotation)
protected boolean	hasHiddenAnnotation(com.fasterxml.jackson.databind.introspect.Annotated annotated)
protected boolean	hiddenByJsonView(Annotation[] annotations, AnnotatedType type)
protected boolean	ignore(com.fasterxml.jackson.databind.introspect.Annotated member, XmlAccessorType xmlAccessorTypeAnnotation, String propName, Set<String> propertiesToIgnore)
protected boolean	ignore(com.fasterxml.jackson.databind.introspect.Annotated member, XmlAccessorType xmlAccessorTypeAnnotation, String propName, Set<String> propertiesToIgnore, com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition propDef)
com.fasterxml.jackson.databind.ObjectMapper	objectMapper()
Schema	resolve(AnnotatedType annotatedType, ModelConverterContext context, Iterator<ModelConverter> next)
protected Schema.AccessMode	resolveAccessMode(com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition propDef, com.fasterxml.jackson.databind.JavaType type, Schema schema)
protected List<String>	resolveAllowableValues(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Object	resolveDefaultValue(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Boolean	resolveDeprecated(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected String	resolveDescription(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Discriminator	resolveDiscriminator(com.fasterxml.jackson.databind.JavaType type, ModelConverterContext context)
protected void	resolveDiscriminatorProperty(com.fasterxml.jackson.databind.JavaType type, ModelConverterContext context, Schema model)
protected Object	resolveExample(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Boolean	resolveExclusiveMaximum(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Boolean	resolveExclusiveMinimum(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Map<String,Object>	resolveExtensions(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Map<String,Object>	resolveExtensions(AnnotatedType a, ArraySchema arraySchema)
protected ExternalDocumentation	resolveExternalDocumentation(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected ExternalDocumentation	resolveExternalDocumentation(ExternalDocumentation externalDocumentation)
protected String	resolveFormat(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Set<String>	resolveIgnoredProperties(Annotation[] annotations)
protected Set<String>	resolveIgnoredProperties(com.fasterxml.jackson.databind.util.Annotations a, Annotation[] annotations)
protected BigDecimal	resolveMaximum(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Integer	resolveMaxItems(AnnotatedType a, ArraySchema arraySchema)
protected Integer	resolveMaxLength(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Integer	resolveMaxProperties(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected BigDecimal	resolveMinimum(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Integer	resolveMinItems(AnnotatedType a, ArraySchema arraySchema)
protected Integer	resolveMinLength(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Integer	resolveMinProperties(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected BigDecimal	resolveMultipleOf(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Boolean	resolveNullable(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected String	resolvePattern(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Map<String,Schema>	resolvePatternProperties(com.fasterxml.jackson.databind.JavaType a, Annotation[] annotations, ModelConverterContext context)
protected Boolean	resolveReadOnly(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected List<String>	resolveRequiredProperties(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected void	resolveSchemaMembers(Schema schema, com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schemaAnnotation)
protected void	resolveSchemaMembers(Schema schema, AnnotatedType annotatedType)
protected Map<String,Schema>	resolveSchemaProperties(com.fasterxml.jackson.databind.JavaType a, Annotation[] annotations, ModelConverterContext context)
protected String	resolveTitle(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected Boolean	resolveUniqueItems(AnnotatedType a, ArraySchema arraySchema)
protected Schema	resolveWrapping(com.fasterxml.jackson.databind.JavaType type, ModelConverterContext context, Schema model)
protected Boolean	resolveWriteOnly(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected XML	resolveXml(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, Schema schema)
protected boolean	shouldIgnoreClass(Type type)

Methods inherited from class io.swagger.v3.core.jackson.AbstractModelConverter

_findTypeName, _isSetType, _subTypeName, _typeName, _typeName, _typeQName

Methods inherited from class java.lang.Object

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

Field Detail

NOT_NULL_ANNOTATIONS

public static List<String> NOT_NULL_ANNOTATIONS

SET_PROPERTY_OF_COMPOSED_MODEL_AS_SIBLING

public static final String SET_PROPERTY_OF_COMPOSED_MODEL_AS_SIBLING

See Also:

Constant Field Values

SET_PROPERTY_OF_ENUMS_AS_REF

public static final String SET_PROPERTY_OF_ENUMS_AS_REF

See Also:

Constant Field Values

composedModelPropertiesAsSibling

public static boolean composedModelPropertiesAsSibling

enumsAsRef

public static boolean enumsAsRef

Allows all enums to be resolved as a reference to a scheme added to the components section.

Constructor Detail

ModelResolver

public ModelResolver(com.fasterxml.jackson.databind.ObjectMapper mapper)

ModelResolver

public ModelResolver(com.fasterxml.jackson.databind.ObjectMapper mapper,
                     TypeNameResolver typeNameResolver)

Method Detail

objectMapper

public com.fasterxml.jackson.databind.ObjectMapper objectMapper()

resolve

public Schema resolve(AnnotatedType annotatedType,
                      ModelConverterContext context,
                      Iterator<ModelConverter> next)

Specified by:

resolve in interface ModelConverter

Overrides:

resolve in class AbstractModelConverter

next - the chain of model converters to try if this implementation cannot process

Returns:

null if this ModelConverter cannot convert the given Type

findJsonValueType

protected Type findJsonValueType(com.fasterxml.jackson.databind.BeanDescription beanDesc)

_isOptionalType

protected boolean _isOptionalType(com.fasterxml.jackson.databind.JavaType propType)

_addEnumProps

protected void _addEnumProps(Class<?> propClass,
                             Schema property)

ignore

protected boolean ignore(com.fasterxml.jackson.databind.introspect.Annotated member,
                         XmlAccessorType xmlAccessorTypeAnnotation,
                         String propName,
                         Set<String> propertiesToIgnore)

hasHiddenAnnotation

protected boolean hasHiddenAnnotation(com.fasterxml.jackson.databind.introspect.Annotated annotated)

ignore

protected boolean ignore(com.fasterxml.jackson.databind.introspect.Annotated member,
                         XmlAccessorType xmlAccessorTypeAnnotation,
                         String propName,
                         Set<String> propertiesToIgnore,
                         com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition propDef)

applyBeanValidatorAnnotations

protected void applyBeanValidatorAnnotations(Schema property,
                                             Annotation[] annotations,
                                             Schema parent)

getComposedSchemaReferencedClasses

protected List<Class<?>> getComposedSchemaReferencedClasses(Class<?> clazz,
                                                            Annotation[] ctxAnnotations,
                                                            Schema schemaAnnotation)

resolveDescription

protected String resolveDescription(com.fasterxml.jackson.databind.introspect.Annotated a,
                                    Annotation[] annotations,
                                    Schema schema)

resolveTitle

protected String resolveTitle(com.fasterxml.jackson.databind.introspect.Annotated a,
                              Annotation[] annotations,
                              Schema schema)

resolveFormat

protected String resolveFormat(com.fasterxml.jackson.databind.introspect.Annotated a,
                               Annotation[] annotations,
                               Schema schema)

resolvePatternProperties

protected Map<String,Schema> resolvePatternProperties(com.fasterxml.jackson.databind.JavaType a,
                                                      Annotation[] annotations,
                                                      ModelConverterContext context)

resolveSchemaProperties

protected Map<String,Schema> resolveSchemaProperties(com.fasterxml.jackson.databind.JavaType a,
                                                     Annotation[] annotations,
                                                     ModelConverterContext context)

resolveDefaultValue

protected Object resolveDefaultValue(com.fasterxml.jackson.databind.introspect.Annotated a,
                                     Annotation[] annotations,
                                     Schema schema)

resolveExample

protected Object resolveExample(com.fasterxml.jackson.databind.introspect.Annotated a,
                                Annotation[] annotations,
                                Schema schema)

resolveAccessMode

protected Schema.AccessMode resolveAccessMode(com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition propDef,
                                              com.fasterxml.jackson.databind.JavaType type,
                                              Schema schema)

resolveReadOnly

protected Boolean resolveReadOnly(com.fasterxml.jackson.databind.introspect.Annotated a,
                                  Annotation[] annotations,
                                  Schema schema)

resolveNullable

protected Boolean resolveNullable(com.fasterxml.jackson.databind.introspect.Annotated a,
                                  Annotation[] annotations,
                                  Schema schema)

resolveMultipleOf

protected BigDecimal resolveMultipleOf(com.fasterxml.jackson.databind.introspect.Annotated a,
                                       Annotation[] annotations,
                                       Schema schema)

resolveMaxLength

protected Integer resolveMaxLength(com.fasterxml.jackson.databind.introspect.Annotated a,
                                   Annotation[] annotations,
                                   Schema schema)

resolveMinLength

protected Integer resolveMinLength(com.fasterxml.jackson.databind.introspect.Annotated a,
                                   Annotation[] annotations,
                                   Schema schema)

resolveMinimum

protected BigDecimal resolveMinimum(com.fasterxml.jackson.databind.introspect.Annotated a,
                                    Annotation[] annotations,
                                    Schema schema)

resolveMaximum

protected BigDecimal resolveMaximum(com.fasterxml.jackson.databind.introspect.Annotated a,
                                    Annotation[] annotations,
                                    Schema schema)

resolveExclusiveMinimum

protected Boolean resolveExclusiveMinimum(com.fasterxml.jackson.databind.introspect.Annotated a,
                                          Annotation[] annotations,
                                          Schema schema)

resolveExclusiveMaximum

protected Boolean resolveExclusiveMaximum(com.fasterxml.jackson.databind.introspect.Annotated a,
                                          Annotation[] annotations,
                                          Schema schema)

resolvePattern

protected String resolvePattern(com.fasterxml.jackson.databind.introspect.Annotated a,
                                Annotation[] annotations,
                                Schema schema)

resolveMinProperties

protected Integer resolveMinProperties(com.fasterxml.jackson.databind.introspect.Annotated a,
                                       Annotation[] annotations,
                                       Schema schema)

resolveMaxProperties

protected Integer resolveMaxProperties(com.fasterxml.jackson.databind.introspect.Annotated a,
                                       Annotation[] annotations,
                                       Schema schema)

resolveRequiredProperties

protected List<String> resolveRequiredProperties(com.fasterxml.jackson.databind.introspect.Annotated a,
                                                 Annotation[] annotations,
                                                 Schema schema)

resolveWriteOnly

protected Boolean resolveWriteOnly(com.fasterxml.jackson.databind.introspect.Annotated a,
                                   Annotation[] annotations,
                                   Schema schema)

resolveExternalDocumentation

protected ExternalDocumentation resolveExternalDocumentation(com.fasterxml.jackson.databind.introspect.Annotated a,
                                                             Annotation[] annotations,
                                                             Schema schema)

resolveExternalDocumentation

protected ExternalDocumentation resolveExternalDocumentation(ExternalDocumentation externalDocumentation)

resolveDeprecated

protected Boolean resolveDeprecated(com.fasterxml.jackson.databind.introspect.Annotated a,
                                    Annotation[] annotations,
                                    Schema schema)

resolveAllowableValues

protected List<String> resolveAllowableValues(com.fasterxml.jackson.databind.introspect.Annotated a,
                                              Annotation[] annotations,
                                              Schema schema)

resolveExtensions

protected Map<String,Object> resolveExtensions(com.fasterxml.jackson.databind.introspect.Annotated a,
                                               Annotation[] annotations,
                                               Schema schema)

resolveDiscriminatorProperty

protected void resolveDiscriminatorProperty(com.fasterxml.jackson.databind.JavaType type,
                                            ModelConverterContext context,
                                            Schema model)

resolveWrapping

protected Schema resolveWrapping(com.fasterxml.jackson.databind.JavaType type,
                                 ModelConverterContext context,
                                 Schema model)

resolveDiscriminator

protected Discriminator resolveDiscriminator(com.fasterxml.jackson.databind.JavaType type,
                                             ModelConverterContext context)

resolveXml

protected XML resolveXml(com.fasterxml.jackson.databind.introspect.Annotated a,
                         Annotation[] annotations,
                         Schema schema)

resolveIgnoredProperties

protected Set<String> resolveIgnoredProperties(com.fasterxml.jackson.databind.util.Annotations a,
                                               Annotation[] annotations)

resolveIgnoredProperties

protected Set<String> resolveIgnoredProperties(Annotation[] annotations)

resolveMinItems

protected Integer resolveMinItems(AnnotatedType a,
                                  ArraySchema arraySchema)

resolveMaxItems

protected Integer resolveMaxItems(AnnotatedType a,
                                  ArraySchema arraySchema)

resolveUniqueItems

protected Boolean resolveUniqueItems(AnnotatedType a,
                                     ArraySchema arraySchema)

resolveExtensions

protected Map<String,Object> resolveExtensions(AnnotatedType a,
                                               ArraySchema arraySchema)

resolveSchemaMembers

protected void resolveSchemaMembers(Schema schema,
                                    AnnotatedType annotatedType)

resolveSchemaMembers

protected void resolveSchemaMembers(Schema schema,
                                    com.fasterxml.jackson.databind.introspect.Annotated a,
                                    Annotation[] annotations,
                                    Schema schemaAnnotation)

addRequiredItem

protected void addRequiredItem(Schema model,
                               String propName)

shouldIgnoreClass

protected boolean shouldIgnoreClass(Type type)

decorateModelName

protected String decorateModelName(AnnotatedType type,
                                   String originalName)

Decorate the name based on the JsonView

hiddenByJsonView

protected boolean hiddenByJsonView(Annotation[] annotations,
                                   AnnotatedType type)