Package io.swagger.jackson

Class AbstractModelConverter

java.lang.Object

io.swagger.jackson.AbstractModelConverter

All Implemented Interfaces:

ModelConverter

Direct Known Subclasses:

ModelResolver

public abstract class AbstractModelConverter
extends Object
implements ModelConverter

Field Summary

Fields

Modifier and Type	Field	Description
protected com.fasterxml.jackson.databind.AnnotationIntrospector	_intr
protected com.fasterxml.jackson.databind.ObjectMapper	_mapper
protected Map<com.fasterxml.jackson.databind.JavaType,String>	_resolvedTypeNames	Minor optimization: no need to keep on resolving same types over and over again.
protected TypeNameResolver	_typeNameResolver

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractModelConverter(com.fasterxml.jackson.databind.ObjectMapper mapper)
protected	AbstractModelConverter(com.fasterxml.jackson.databind.ObjectMapper mapper, TypeNameResolver typeNameResolver)

Method Summary

Modifier and Type	Method	Description
protected String	_description(com.fasterxml.jackson.databind.introspect.Annotated ann)
protected String	_findDefaultValue(com.fasterxml.jackson.databind.introspect.Annotated a)
protected String	_findExampleValue(com.fasterxml.jackson.databind.introspect.Annotated a)
protected Boolean	_findReadOnly(com.fasterxml.jackson.databind.introspect.Annotated a)
protected Boolean	_findReadOnlyFromAccessMode(com.fasterxml.jackson.databind.introspect.Annotated a)
protected String	_findTypeName(com.fasterxml.jackson.databind.JavaType type, com.fasterxml.jackson.databind.BeanDescription beanDesc)
protected boolean	_isSetType(Class<?> cls)
protected String	_subTypeName(com.fasterxml.jackson.databind.jsontype.NamedType type)
protected String	_typeName(com.fasterxml.jackson.databind.JavaType type)
protected String	_typeName(com.fasterxml.jackson.databind.JavaType type, com.fasterxml.jackson.databind.BeanDescription beanDesc)
protected String	_typeQName(com.fasterxml.jackson.databind.JavaType type)
protected static Comparator<Property>	getPropertyComparator()
protected boolean	prioritizeAnnotationInspectorSchemaName()	whether to resolve schema name by first using AnnotationInspector registered implementations defaults to false, override returning `true` to obtain pre-1.5.24 behaviour
Model	resolve(Type type, ModelConverterContext context, Iterator<ModelConverter> chain)
Property	resolveProperty(Type type, ModelConverterContext context, Annotation[] annotations, Iterator<ModelConverter> chain)

Methods inherited from class java.lang.Object

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

Field Detail

_mapper

protected final com.fasterxml.jackson.databind.ObjectMapper _mapper

_intr

protected final com.fasterxml.jackson.databind.AnnotationIntrospector _intr

_typeNameResolver

protected final TypeNameResolver _typeNameResolver

_resolvedTypeNames

protected Map<com.fasterxml.jackson.databind.JavaType,String> _resolvedTypeNames

Minor optimization: no need to keep on resolving same types over and over again.

Constructor Detail

AbstractModelConverter

protected AbstractModelConverter(com.fasterxml.jackson.databind.ObjectMapper mapper)

AbstractModelConverter

protected AbstractModelConverter(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                 TypeNameResolver typeNameResolver)

Method Detail

getPropertyComparator

protected static Comparator<Property> getPropertyComparator()

resolveProperty

public Property resolveProperty(Type type,
                                ModelConverterContext context,
                                Annotation[] annotations,
                                Iterator<ModelConverter> chain)

Specified by:

resolveProperty in interface ModelConverter

annotations - to consider when resolving the property

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

Returns:

null if this ModelConverter cannot convert the given Type

_description

protected String _description(com.fasterxml.jackson.databind.introspect.Annotated ann)

_typeName

protected String _typeName(com.fasterxml.jackson.databind.JavaType type)

_typeName

protected String _typeName(com.fasterxml.jackson.databind.JavaType type,
                           com.fasterxml.jackson.databind.BeanDescription beanDesc)

prioritizeAnnotationInspectorSchemaName

protected boolean prioritizeAnnotationInspectorSchemaName()

whether to resolve schema name by first using AnnotationInspector registered implementations defaults to false, override returning `true` to obtain pre-1.5.24 behaviour

Returns:

false

Since:

1.5.24

_findTypeName

protected String _findTypeName(com.fasterxml.jackson.databind.JavaType type,
                               com.fasterxml.jackson.databind.BeanDescription beanDesc)

_typeQName

protected String _typeQName(com.fasterxml.jackson.databind.JavaType type)

_subTypeName

protected String _subTypeName(com.fasterxml.jackson.databind.jsontype.NamedType type)

_findDefaultValue

protected String _findDefaultValue(com.fasterxml.jackson.databind.introspect.Annotated a)

_findExampleValue

protected String _findExampleValue(com.fasterxml.jackson.databind.introspect.Annotated a)

_findReadOnly

protected Boolean _findReadOnly(com.fasterxml.jackson.databind.introspect.Annotated a)

_findReadOnlyFromAccessMode

protected Boolean _findReadOnlyFromAccessMode(com.fasterxml.jackson.databind.introspect.Annotated a)

_isSetType

protected boolean _isSetType(Class<?> cls)

resolve

public Model resolve(Type type,
                     ModelConverterContext context,
                     Iterator<ModelConverter> chain)

Specified by:

resolve in interface ModelConverter

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

Returns:

null if this ModelConverter cannot convert the given Type