org.springdoc.core

Class ParameterInfo

java.lang.Object

org.springdoc.core.ParameterInfo

public class ParameterInfo
extends Object

The type Parameter info.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
ParameterInfo(String pName, org.springframework.core.MethodParameter methodParameter, GenericParameterService genericParameterService, io.swagger.v3.oas.annotations.Parameter parameterAnnotation) Instantiates a new Parameter info.

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue() Gets default value.
org.springframework.core.MethodParameter	getMethodParameter() Gets method parameter.
ParameterId	getParameterId() Gets parameter id.
io.swagger.v3.oas.models.parameters.Parameter	getParameterModel() Gets parameter model.
String	getParamType() Gets param type.
String	getpName() Gets name.
boolean	isRequestPart() Is request part boolean.
boolean	isRequired() Is required boolean.
void	setDefaultValue(Object defaultValue) Sets default value.
void	setParameterId(ParameterId parameterId) Sets parameter id.
void	setParameterModel(io.swagger.v3.oas.models.parameters.Parameter parameterModel) Sets parameter model.
void	setParamType(String paramType) Sets param type.
void	setpName(String pName) Sets name.
void	setRequestPart(boolean requestPart) Sets request part.
void	setRequired(boolean required) Sets required.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterInfo

public ParameterInfo(String pName,
                     org.springframework.core.MethodParameter methodParameter,
                     GenericParameterService genericParameterService,
                     io.swagger.v3.oas.annotations.Parameter parameterAnnotation)

Instantiates a new Parameter info.

Parameters:

pName - the parameter name

methodParameter - the method parameter

genericParameterService - the parameter builder

parameterAnnotation - the parameter annotation

Method Detail

getpName

public String getpName()

Gets name.

Returns:

the name

setpName

public void setpName(String pName)

Sets name.

Parameters:

pName - the p name

getMethodParameter

public org.springframework.core.MethodParameter getMethodParameter()

Gets method parameter.

Returns:

the method parameter

getParameterModel

public io.swagger.v3.oas.models.parameters.Parameter getParameterModel()

Gets parameter model.

Returns:

the parameter model

setParameterModel

public void setParameterModel(io.swagger.v3.oas.models.parameters.Parameter parameterModel)

Sets parameter model.

Parameters:

parameterModel - the parameter model

isRequired

public boolean isRequired()

Is required boolean.

Returns:

the boolean

setRequired

public void setRequired(boolean required)

Sets required.

Parameters:

required - the required

getDefaultValue

public Object getDefaultValue()

Gets default value.

Returns:

the default value

setDefaultValue

public void setDefaultValue(Object defaultValue)

Sets default value.

Parameters:

defaultValue - the default value

getParamType

public String getParamType()

Gets param type.

Returns:

the param type

setParamType

public void setParamType(String paramType)

Sets param type.

Parameters:

paramType - the param type

isRequestPart

public boolean isRequestPart()

Is request part boolean.

Returns:

the boolean

setRequestPart

public void setRequestPart(boolean requestPart)

Sets request part.

Parameters:

requestPart - the request part

getParameterId

public ParameterId getParameterId()

Gets parameter id.

Returns:

the parameter id

setParameterId

public void setParameterId(ParameterId parameterId)

Sets parameter id.

Parameters:

parameterId - the parameter id