Package springfox.documentation.builders

Class RequestParameterBuilder

java.lang.Object

springfox.documentation.builders.RequestParameterBuilder

public class RequestParameterBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
RequestParameterBuilder()

Method Summary

Modifier and Type	Method	Description
RequestParameterBuilder	accepts(java.util.Collection<org.springframework.http.MediaType> accepts)
RequestParameter	build()
RequestParameterBuilder	content(java.util.function.Consumer<ContentSpecificationBuilder> parameter)
void	contentModel(ModelSpecification model)
RequestParameterBuilder	copyOf(RequestParameter source)
RequestParameterBuilder	deprecated(java.lang.Boolean deprecated)
RequestParameterBuilder	description(java.lang.String description)
RequestParameterBuilder	example(Example scalarExample)
RequestParameterBuilder	examples(java.util.Collection<Example> examples)
RequestParameterBuilder	extensions(java.util.List<VendorExtension> extensions)
RequestParameterBuilder	hidden(java.lang.Boolean hidden)
RequestParameterBuilder	in(java.lang.String in)
RequestParameterBuilder	in(ParameterType in)
RequestParameterBuilder	name(java.lang.String name)
RequestParameterBuilder	parameterIndex(int parameterIndex)
RequestParameterBuilder	parameterSpecificationProvider(ParameterSpecificationProvider specificationProvider)
RequestParameterBuilder	precedence(int precedence)
RequestParameterBuilder	query(java.util.function.Consumer<SimpleParameterSpecificationBuilder> parameter)
RequestParameterBuilder	required(java.lang.Boolean required)
RequestParameterBuilder	validator(Validator<RequestParameterBuilder> validator)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestParameterBuilder

public RequestParameterBuilder()

Method Detail

name

public RequestParameterBuilder name(java.lang.String name)

in

public RequestParameterBuilder in(ParameterType in)

in

public RequestParameterBuilder in(java.lang.String in)

description

public RequestParameterBuilder description(java.lang.String description)

required

public RequestParameterBuilder required(java.lang.Boolean required)

deprecated

public RequestParameterBuilder deprecated(java.lang.Boolean deprecated)

query

public RequestParameterBuilder query(@NonNull
                                     java.util.function.Consumer<SimpleParameterSpecificationBuilder> parameter)

content

public RequestParameterBuilder content(java.util.function.Consumer<ContentSpecificationBuilder> parameter)

extensions

public RequestParameterBuilder extensions(java.util.List<VendorExtension> extensions)

hidden

public RequestParameterBuilder hidden(java.lang.Boolean hidden)

precedence

public RequestParameterBuilder precedence(int precedence)

example

public RequestParameterBuilder example(Example scalarExample)

examples

public RequestParameterBuilder examples(java.util.Collection<Example> examples)

parameterSpecificationProvider

public RequestParameterBuilder parameterSpecificationProvider(ParameterSpecificationProvider specificationProvider)

accepts

public RequestParameterBuilder accepts(java.util.Collection<org.springframework.http.MediaType> accepts)

validator

public RequestParameterBuilder validator(Validator<RequestParameterBuilder> validator)

parameterIndex

public RequestParameterBuilder parameterIndex(int parameterIndex)

build

public RequestParameter build()

copyOf

public RequestParameterBuilder copyOf(RequestParameter source)

contentModel

public void contentModel(ModelSpecification model)