springfox.documentation.builders

Class ParameterBuilder

java.lang.Object

springfox.documentation.builders.ParameterBuilder

public class ParameterBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ParameterBuilder()

Method Summary

Modifier and Type	Method and Description
ParameterBuilder	allowableValues(AllowableValues allowableValues) Updates if the parameter is bound by a range of values or a range of numerical values
ParameterBuilder	allowEmptyValue(java.lang.Boolean allowEmptyValue) Updates the flag that allows sending empty values for this parameter
ParameterBuilder	allowMultiple(boolean allowMultiple) Updates if the parameter should allow multiple values
Parameter	build()
ParameterBuilder	collectionFormat(java.lang.String collectionFormat) Updates the parameter extensions
ParameterBuilder	complexExamples(com.google.common.collect.Multimap<java.lang.String,Example> examples)
ParameterBuilder	defaultValue(java.lang.String defaultValue) Updates the default value of the parameter
ParameterBuilder	description(java.lang.String description) Updates the description of the parameter
ParameterBuilder	hidden(boolean hidden) Updates if the parameter is hidden
ParameterBuilder	modelRef(ModelReference modelRef) Represents the convenience method to infer the model reference Consolidate or figure out whats can be rolled into the other.
ParameterBuilder	name(java.lang.String name) Updates the parameter name
ParameterBuilder	order(int order) Updates default order of precedence of parameters
ParameterBuilder	parameterAccess(java.lang.String paramAccess) Updates the parameter access
ParameterBuilder	parameterType(java.lang.String paramType) Updates the type of parameter
ParameterBuilder	pattern(java.lang.String pattern)
ParameterBuilder	required(boolean required) Updates if the parameter is required or optional
ParameterBuilder	scalarExample(java.lang.Object scalarExample)
ParameterBuilder	type(com.fasterxml.classmate.ResolvedType type) Updates the type of parameter
ParameterBuilder	vendorExtensions(java.util.List<VendorExtension> extensions) Updates the parameter extensions

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterBuilder

public ParameterBuilder()

Method Detail

name

public ParameterBuilder name(java.lang.String name)

Updates the parameter name

Parameters:

name - - name of the parameter

Returns:

this

description

public ParameterBuilder description(java.lang.String description)

Updates the description of the parameter

Parameters:

description - - description

Returns:

this

defaultValue

public ParameterBuilder defaultValue(java.lang.String defaultValue)

Updates the default value of the parameter

Parameters:

defaultValue - - default value

Returns:

this

required

public ParameterBuilder required(boolean required)

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)

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)

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

public ParameterBuilder parameterType(java.lang.String paramType)

Updates the type of parameter

Parameters:

paramType - - Could be header, cookie, body, query etc.

Returns:

this

parameterAccess

public ParameterBuilder parameterAccess(java.lang.String paramAccess)

Updates the parameter access

Parameters:

paramAccess - - parameter access

Returns:

this

type

public ParameterBuilder type(com.fasterxml.classmate.ResolvedType type)

Updates the type of parameter

Parameters:

type - - represents the resolved type of the parameter

Returns:

this

modelRef

public ParameterBuilder modelRef(ModelReference modelRef)

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)

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)

Updates the parameter extensions

Parameters:

extensions - - parameter extensions

Returns:

this

collectionFormat

public ParameterBuilder collectionFormat(java.lang.String collectionFormat)

Updates the parameter extensions

Parameters:

collectionFormat - - parameter collection format

Returns:

this

Since:

2.8.0

allowEmptyValue

public ParameterBuilder allowEmptyValue(java.lang.Boolean allowEmptyValue)

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)

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)

scalarExample

public ParameterBuilder scalarExample(java.lang.Object scalarExample)

Parameters:

scalarExample - example for non-body parameters

Returns:

this

Since:

2.8.1

complexExamples

public ParameterBuilder complexExamples(com.google.common.collect.Multimap<java.lang.String,Example> examples)

Parameters:

examples - example for body parameters

Returns:

this

Since:

2.8.1

build

public Parameter build()