Package springfox.documentation.builders

Class ModelBuilder

  • @Deprecated
public class ModelBuilder
extends java.lang.Object
    Deprecated.
    Since:
    3.0.0 use ModelSpecificationBuilder instead

    • Constructor Detail

      • ModelBuilder

        public ModelBuilder​(Model model)
        Deprecated.
        Constructor with the model
        Parameters:
        model - - existing model

      • ModelBuilder

        public ModelBuilder​(java.lang.String id)
        Deprecated.
        Constructor with the Id of the model
        Parameters:
        id - - identifier for the model

    • Method Detail

      • name

        public ModelBuilder name​(java.lang.String name)
        Deprecated.
        Updates the Name of the model
        Parameters:
        name - - name of the model
        Returns:
        this

      • qualifiedType

        public ModelBuilder qualifiedType​(java.lang.String qualifiedType)
        Deprecated.
        Fully package qualified name of the model
        Parameters:
        qualifiedType - - package qualified name
        Returns:
        this

      • properties

        public ModelBuilder properties​(java.util.Map<java.lang.String,​ModelProperty> properties)
        Deprecated.
        Updates the model properties
        Parameters:
        properties - - map of properties by name
        Returns:
        this

      • description

        public ModelBuilder description​(java.lang.String description)
        Deprecated.
        Update the description of the model
        Parameters:
        description - - description
        Returns:
        this

      • baseModel

        public ModelBuilder baseModel​(java.lang.String baseModel)
        Deprecated.
        Update the based model
        Parameters:
        baseModel - - based model as in inherited parent model. We currently don't implement this feature
        Returns:
        this

      • discriminator

        public ModelBuilder discriminator​(java.lang.String discriminator)
        Deprecated.
        Updates inheritance discriminator, used to identify inherited subclasses. We currently don't implement this feature
        Parameters:
        discriminator - - inheritance discriminator
        Returns:
        this

      • subTypes

        public ModelBuilder subTypes​(java.util.List<ModelReference> subTypes)
        Deprecated.
        Updates the subclasses for this model.
        Parameters:
        subTypes - - Models inheriting from this model
        Returns:
        this
        Since:
        2.8.1 We changed the subType to be a model refers

      • example

        public ModelBuilder example​(java.lang.Object example)
        Deprecated.
        Updates the Example for the model
        Parameters:
        example - - example of the model
        Returns:
        this
        Since:
        2.8.1

      • type

        public ModelBuilder type​(com.fasterxml.classmate.ResolvedType modelType)
        Deprecated.
        Represents the type information with full fidelity of generics
        Parameters:
        modelType - - resolved type that represents the model
        Returns:
        this

      • build

        public Model build()
        Deprecated.