io.swagger.converter.ModelConverterContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-core Show documentation

There is a newer version: 2.0.0-rc2

package io.swagger.converter;

import io.swagger.models.Model;
import io.swagger.models.properties.Property;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Iterator;

public interface ModelConverterContext {

    /**
     * needs to be called whenever a Model is defined which can be referenced from another
     * Model or Property
     *
     * @param name  the name of the model
     * @param model the Model
     */
    public void defineModel(String name, Model model);

    /**
     * needs to be called whenever a Model is defined which can be referenced from another
     * Model or Property
     *
     * @param name     the name of the model
     * @param model    the Model
     * @param type     the Type
     * @param prevName the (optional) previous name
     */
    public void defineModel(String name, Model model, Type type, String prevName);

    /**
     * @param type the property Class
     * @return a property representation of the Class. Any referenced models will be defined already.
     */
    public Property resolveProperty(Type type, Annotation[] annotations);

    /**
     * @param type The Model Class
     * @return a Model representation of the Class. Any referenced models will be defined already.
     */
    public Model resolve(Type type);

    /**
     * @return an Iterator of ModelConverters.  This iterator is not reused
     */
    public Iterator getConverters();
}