Package springfox.documentation.builders

Class ParameterBuilder

  • @Deprecated
public class ParameterBuilder
extends java.lang.Object
    Deprecated.
    Since:
    3.0.0 Use @see RequestParameterBuilder

    • Constructor Detail

      • ParameterBuilder

        public ParameterBuilder()
        Deprecated.

    • Method Detail

      • name

        public ParameterBuilder name​(java.lang.String name)
        Deprecated.
        Updates the parameter name
        Parameters:
        name - - name of the parameter
        Returns:
        this

      • description

        public ParameterBuilder description​(java.lang.String description)
        Deprecated.
        Updates the description of the parameter
        Parameters:
        description - - description
        Returns:
        this

      • defaultValue

        public ParameterBuilder defaultValue​(java.lang.String defaultValue)
        Deprecated.
        Updates the default value of the parameter
        Parameters:
        defaultValue - - default value
        Returns:
        this

      • required

        public ParameterBuilder required​(boolean required)
        Deprecated.
        Updates if the parameter is required or optional
        Parameters:
        required - - flag to indicate if the parameter is required
        Returns:
        this

      • allowMultiple

        public ParameterBuilder allowMultiple​(boolean allowMultiple)
        Deprecated.
        Updates if the parameter should allow multiple values
        Parameters:
        allowMultiple - - flag to indicate if the parameter supports multi-value
        Returns:
        this

      • allowableValues

        public ParameterBuilder allowableValues​(AllowableValues allowableValues)
        Deprecated.
        Updates if the parameter is bound by a range of values or a range of numerical values
        Parameters:
        allowableValues - - allowable values (instance of @see springfox.documentation.service.AllowableListValues or @see springfox.documentation.service.AllowableRangeValues)
        Returns:
        this

      • parameterType

        @Deprecated
public ParameterBuilder parameterType​(java.lang.String paramType)
        Deprecated.
        Updates the type of parameter
        Parameters:
        paramType - - Could be header, cookie, body, query etc.
        Returns:
        this
        Since:
        3.0.0. Use @see parameterType(ParameterType) instead

      • parameterType

        public ParameterBuilder parameterType​(ParameterType paramType)
        Deprecated.
        Updates the type of parameter
        Parameters:
        paramType - - Could be header, cookie, body, query etc.
        Returns:
        this
        Since:
        3.0.0

      • parameterAccess

        public ParameterBuilder parameterAccess​(java.lang.String paramAccess)
        Deprecated.
        Updates the parameter access
        Parameters:
        paramAccess - - parameter access
        Returns:
        this

      • type

        public ParameterBuilder type​(com.fasterxml.classmate.ResolvedType type)
        Deprecated.
        Updates the type of parameter
        Parameters:
        type - - represents the resolved type of the parameter
        Returns:
        this

      • modelRef

        public ParameterBuilder modelRef​(ModelReference modelRef)
        Deprecated.
        Represents the convenience method to infer the model reference Consolidate or figure out whats can be rolled into the other.
        Parameters:
        modelRef - model reference
        Returns:
        this

      • hidden

        public ParameterBuilder hidden​(boolean hidden)
        Deprecated.
        Updates if the parameter is hidden
        Parameters:
        hidden - - flag to indicate if the parameter is hidden
        Returns:
        this

      • vendorExtensions

        public ParameterBuilder vendorExtensions​(java.util.List<VendorExtension> extensions)
        Deprecated.
        Updates the parameter extensions
        Parameters:
        extensions - - parameter extensions
        Returns:
        this

      • collectionFormat

        public ParameterBuilder collectionFormat​(java.lang.String collectionFormat)
        Deprecated.
        Updates the parameter extensions
        Parameters:
        collectionFormat - - parameter collection format
        Returns:
        this
        Since:
        2.8.0

      • allowEmptyValue

        public ParameterBuilder allowEmptyValue​(java.lang.Boolean allowEmptyValue)
        Deprecated.
        Updates the flag that allows sending empty values for this parameter
        Parameters:
        allowEmptyValue - - true/false
        Returns:
        this
        Since:
        2.8.1

      • order

        public ParameterBuilder order​(int order)
        Deprecated.
        Updates default order of precedence of parameters
        Parameters:
        order - - between Ordered.HIGHEST_PRECEDENCE, Ordered.LOWEST_PRECEDENCE
        Returns:
        this
        Since:
        2.8.1

      • pattern

        public ParameterBuilder pattern​(java.lang.String pattern)
        Deprecated.

      • scalarExample

        public ParameterBuilder scalarExample​(java.lang.Object scalarExample)
        Deprecated.
        Parameters:
        scalarExample - example for non-body parameters
        Returns:
        this
        Since:
        2.8.1

      • complexExamples

        public ParameterBuilder complexExamples​(java.util.Map<java.lang.String,​java.util.List<Example>> examples)
        Deprecated.
        Parameters:
        examples - example for body parameters
        Returns:
        this
        Since:
        2.8.1

      • style

        public ParameterBuilder style​(ParameterStyle style)
        Deprecated.
        Parameters:
        style - https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#style-values
        Returns:
        this
        Since:
        3.0.0

      • explode

        public ParameterBuilder explode​(java.lang.Boolean explode)
        Deprecated.
        Parameters:
        explode - When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
        Returns:
        this
        Since:
        3.0.0

      • allowReserved

        public ParameterBuilder allowReserved​(java.lang.Boolean allowReserved)
        Deprecated.
        Parameters:
        allowReserved - Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.
        Returns:
        this
        Since:
        3.0.0

      • build

        public Parameter build()
        Deprecated.