public class ParameterBuilder
extends java.lang.Object
Constructor and Description |
---|
ParameterBuilder() |
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 |
allowMultiple(boolean allowMultiple)
Updates if the parameter should allow multiple values
|
Parameter |
build() |
ParameterBuilder |
defaultValue(java.lang.String defaultValue)
Updates the default value of the parametr
|
ParameterBuilder |
description(java.lang.String description)
Updates the description of the parameter
|
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 |
parameterAccess(java.lang.String paramAccess)
Updates the parameter access
|
ParameterBuilder |
parameterType(java.lang.String paramType)
Updates the type of parameter
|
ParameterBuilder |
required(boolean required)
Updates if the parameter is required or optional
|
ParameterBuilder |
type(com.fasterxml.classmate.ResolvedType type)
Updates the type of parameter
|
public ParameterBuilder name(java.lang.String name)
name
- - name of the parameterpublic ParameterBuilder description(java.lang.String description)
description
- - descriptionpublic ParameterBuilder defaultValue(java.lang.String defaultValue)
defaultValue
- - default valuepublic ParameterBuilder required(boolean required)
required
- - flag to indicate if the parameter is requiredpublic ParameterBuilder allowMultiple(boolean allowMultiple)
allowMultiple
- - flag to indicate if the parameter supports multi-valuepublic ParameterBuilder allowableValues(AllowableValues allowableValues)
allowableValues
- - allowable values (instance of @see springfox.documentation.service.AllowableListValues
or @see springfox.documentation.service.AllowableRangeValues)public ParameterBuilder parameterType(java.lang.String paramType)
paramType
- - Could be header, cookie, body, query etc.public ParameterBuilder parameterAccess(java.lang.String paramAccess)
paramAccess
- - parameter accesspublic ParameterBuilder type(com.fasterxml.classmate.ResolvedType type)
type
- - represents the resolved type of the parameterpublic ParameterBuilder modelRef(ModelReference modelRef)
modelRef
- public Parameter build()