Package springfox.documentation.builders

Class SimpleParameterSpecificationBuilder

java.lang.Object

springfox.documentation.builders.SimpleParameterSpecificationBuilder

public class SimpleParameterSpecificationBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
SimpleParameterSpecificationBuilder()

Method Summary

Modifier and Type	Method	Description
SimpleParameterSpecificationBuilder	allowEmptyValue(java.lang.Boolean allowEmptyValue)	Allows empty values
SimpleParameterSpecificationBuilder	allowReserved(java.lang.Boolean allowReserved)	Allows reserved characters
SimpleParameterSpecificationBuilder	collectionFacet(java.util.function.Consumer<CollectionElementFacetBuilder> facet)	Provides consumer to help uild collection element facet
SimpleParameterSpecificationBuilder	collectionFormat(CollectionFormat collectionFormat)	Deprecated.
SimpleParameterSpecificationBuilder	copyOf(SimpleParameterSpecification other)	Method they copy from a specification
SimpleParameterSpecificationBuilder	defaultValue(java.lang.String defaultValue)	Default value
SimpleParameterSpecificationBuilder	enumerationFacet(java.util.function.Consumer<EnumerationElementFacetBuilder> facet)	Provides consumer to help build enumeration element facet
SimpleParameterSpecificationBuilder	explode(java.lang.Boolean explode)	Use this if we want to explode collections
SimpleParameterSpecificationBuilder	model(java.util.function.Consumer<ModelSpecificationBuilder> consumer)	Provides consumer to help build models
SimpleParameterSpecificationBuilder	numericFacet(java.util.function.Consumer<NumericElementFacetBuilder> facet)	Provides consumer to help build numeric element facet
SimpleParameterSpecificationBuilder	stringFacet(java.util.function.Consumer<StringElementFacetBuilder> facet)	Provides consumer to help build string element facet
SimpleParameterSpecificationBuilder	style(ParameterStyle style)	Parameter style

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleParameterSpecificationBuilder

public SimpleParameterSpecificationBuilder()

Method Detail

style

public SimpleParameterSpecificationBuilder style(ParameterStyle style)

Parameter style

Parameters:

style - - parameter style

Returns:

this

explode

public SimpleParameterSpecificationBuilder explode(java.lang.Boolean explode)

Use this if we want to explode collections

Parameters:

explode - - explodes collection

Returns:

this

allowReserved

public SimpleParameterSpecificationBuilder allowReserved(java.lang.Boolean allowReserved)

Allows reserved characters

Parameters:

allowReserved - - allow reserved characters

Returns:

this

model

public SimpleParameterSpecificationBuilder model(@NonNull
                                                 java.util.function.Consumer<ModelSpecificationBuilder> consumer)

Provides consumer to help build models

Parameters:

consumer - - consumer that facilitates building a model

Returns:

this

allowEmptyValue

public SimpleParameterSpecificationBuilder allowEmptyValue(java.lang.Boolean allowEmptyValue)

Allows empty values

Parameters:

allowEmptyValue - - flag to indicate empty values are allowed

Returns:

this

defaultValue

public SimpleParameterSpecificationBuilder defaultValue(java.lang.String defaultValue)

Default value

Parameters:

defaultValue - - default value

Returns:

this

collectionFormat

@Deprecated
public SimpleParameterSpecificationBuilder collectionFormat(CollectionFormat collectionFormat)

Deprecated.

This is only there to set the collection format for swagger 2

Parameters:

collectionFormat - - collection format

Returns:

this

collectionFacet

public SimpleParameterSpecificationBuilder collectionFacet(@NonNull
                                                           java.util.function.Consumer<CollectionElementFacetBuilder> facet)

Provides consumer to help uild collection element facet

Parameters:

facet - - consumer that facilitates building a collection facet

Returns:

this

stringFacet

public SimpleParameterSpecificationBuilder stringFacet(@NonNull
                                                       java.util.function.Consumer<StringElementFacetBuilder> facet)

Provides consumer to help build string element facet

Parameters:

facet - - consumer that facilitates building a string facet

Returns:

this

numericFacet

public SimpleParameterSpecificationBuilder numericFacet(@NonNull
                                                        java.util.function.Consumer<NumericElementFacetBuilder> facet)

Provides consumer to help build numeric element facet

Parameters:

facet - - consumer that facilitates building a numeric facet

Returns:

this

enumerationFacet

public SimpleParameterSpecificationBuilder enumerationFacet(@NonNull
                                                            java.util.function.Consumer<EnumerationElementFacetBuilder> facet)

Provides consumer to help build enumeration element facet

Parameters:

facet - - consumer that facilitates building a enumeration facet

Returns:

this

copyOf

public SimpleParameterSpecificationBuilder copyOf(SimpleParameterSpecification other)

Method they copy from a specification

Parameters:

other - - other spec to copy from

Returns:

this