io.swagger.v3.core.converter

Class ModelConverterContextImpl

java.lang.Object

io.swagger.v3.core.converter.ModelConverterContextImpl

All Implemented Interfaces:

ModelConverterContext

public class ModelConverterContextImpl
extends Object
implements ModelConverterContext

Constructor Summary

Constructors

Constructor and Description
ModelConverterContextImpl(List<ModelConverter> converters)
ModelConverterContextImpl(ModelConverter converter)

Method Summary

Modifier and Type	Method and Description
void	defineModel(String name, io.swagger.v3.oas.models.media.Schema model) needs to be called whenever a Model is defined which can be referenced from another Model or Property
void	defineModel(String name, io.swagger.v3.oas.models.media.Schema model, AnnotatedType type, String prevName) needs to be called whenever a Schema is defined which can be referenced from another Model or Property
void	defineModel(String name, io.swagger.v3.oas.models.media.Schema model, Type type, String prevName) needs to be called whenever a Schema is defined which can be referenced from another Model or Property
Iterator<ModelConverter>	getConverters()
Map<String,io.swagger.v3.oas.models.media.Schema>	getDefinedModels()
io.swagger.v3.oas.models.media.Schema	resolve(AnnotatedType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelConverterContextImpl

public ModelConverterContextImpl(List<ModelConverter> converters)

ModelConverterContextImpl

public ModelConverterContextImpl(ModelConverter converter)

Method Detail

getConverters

public Iterator<ModelConverter> getConverters()

Specified by:

getConverters in interface ModelConverterContext

Returns:

an Iterator of ModelConverters. This iterator is not reused

defineModel

public void defineModel(String name,
                        io.swagger.v3.oas.models.media.Schema model)

Description copied from interface: ModelConverterContext

needs to be called whenever a Model is defined which can be referenced from another Model or Property

Specified by:

defineModel in interface ModelConverterContext

Parameters:

name - the name of the model

model - the Model

defineModel

public void defineModel(String name,
                        io.swagger.v3.oas.models.media.Schema model,
                        Type type,
                        String prevName)

Description copied from interface: ModelConverterContext

needs to be called whenever a Schema is defined which can be referenced from another Model or Property

Specified by:

defineModel in interface ModelConverterContext

Parameters:

name - the name of the model

model - the Model

type - the Type

prevName - the (optional) previous name

defineModel

public void defineModel(String name,
                        io.swagger.v3.oas.models.media.Schema model,
                        AnnotatedType type,
                        String prevName)

Description copied from interface: ModelConverterContext

needs to be called whenever a Schema is defined which can be referenced from another Model or Property

Specified by:

defineModel in interface ModelConverterContext

Parameters:

name - the name of the model

model - the Model

type - the AnnotatedType

prevName - the (optional) previous name

getDefinedModels

public Map<String,io.swagger.v3.oas.models.media.Schema> getDefinedModels()

Specified by:

getDefinedModels in interface ModelConverterContext

resolve

public io.swagger.v3.oas.models.media.Schema resolve(AnnotatedType type)

Specified by:

resolve in interface ModelConverterContext

Parameters:

type - The Schema

Returns:

a Model representation of the Class. Any referenced models will be defined already.