Package springfox.documentation.builders

Class ModelSpecificationBuilder

  • public class ModelSpecificationBuilder
extends java.lang.Object

    • Constructor Detail

      • ModelSpecificationBuilder

        public ModelSpecificationBuilder()

    • Method Detail

      • name

        public ModelSpecificationBuilder name​(@NonNull
                                      java.lang.String name)
        Updates the name of the model
        Parameters:
        name - - Name of the model
        Returns:
        this

      • facets

        public ModelSpecificationBuilder facets​(@NonNull
                                        java.util.function.Consumer<ModelFacetsBuilder> facets)
        Provides a consumer to build facets
        Parameters:
        facets - - consumer that facilitates building a facet
        Returns:
        this

      • compoundModel

        public ModelSpecificationBuilder compoundModel​(@NonNull
                                               java.util.function.Consumer<CompoundModelSpecificationBuilder> compound)
        Provides a consumer to help building a compound model
        Parameters:
        compound - - consumer that facilitates building a compound model
        Returns:
        this

      • compoundModelIfExists

        public ModelSpecificationBuilder compoundModelIfExists​(@NonNull
                                                       java.util.function.Consumer<CompoundModelSpecificationBuilder> compound)
        Provides a consumer to help build a compound model if one already exists. If the model is a different type, then any operations done with the help of the consumer will be a no-op
        Parameters:
        compound - consumer that facilitates building a compound model
        Returns:
        this

      • collectionModel

        public ModelSpecificationBuilder collectionModel​(@NonNull
                                                 java.util.function.Consumer<CollectionSpecificationBuilder> consumer)
        Provides a consumer to build the collection model
        Parameters:
        consumer - consumer that facilitates building a collection
        Returns:
        this

      • collectionModelIfExists

        public ModelSpecificationBuilder collectionModelIfExists​(@NonNull
                                                         java.util.function.Consumer<CollectionSpecificationBuilder> consumer)
        Conditionally provides a consumer to build the colleciton model. If the model is a different type, then any operations done with the help of the consumer will be a no-op
        Parameters:
        consumer - consumer that facilitates building a collection
        Returns:
        this

      • mapModel

        public ModelSpecificationBuilder mapModel​(@NonNull
                                          java.util.function.Consumer<MapSpecificationBuilder> consumer)
        Provides a consumer to build the map model.
        Parameters:
        consumer - consumer that facilitates building a map
        Returns:
        this

      • mapModelIfExists

        public ModelSpecificationBuilder mapModelIfExists​(@NonNull
                                                  java.util.function.Consumer<MapSpecificationBuilder> consumer)
        Conditionally provides a consumer to build the map model.
        Parameters:
        consumer - consumer that facilitates building a map
        Returns:
        this

      • referenceModelIfExists

        public ModelSpecificationBuilder referenceModelIfExists​(java.util.function.Consumer<ReferenceModelSpecificationBuilder> consumer)
        Provides a consumer to build the reference model.
        Parameters:
        consumer - consumer that facilitates building a reference model
        Returns:
        this

      • maybeConvertToScalar

        public ModelSpecificationBuilder maybeConvertToScalar​(ScalarType scalar)
        This is an experimental API. May be removed/modified
        Parameters:
        scalar - - scalar to replace the models with
        Returns:
        this