Package org.springdoc.core.models
Class ParameterInfo
java.lang.Object
org.springdoc.core.models.ParameterInfo
The type Parameter info.
- Author:
- bnasslahsen
-
Constructor Summary
ConstructorsConstructorDescriptionParameterInfo(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 TypeMethodDescriptionGets default value.org.springframework.core.MethodParameterGets method parameter.Gets parameter id.io.swagger.v3.oas.models.parameters.ParameterGets parameter model.Gets param type.getpName()Gets name.booleanIs request part boolean.booleanIs required boolean.voidsetDefaultValue(Object defaultValue) Sets default value.voidsetParameterId(ParameterId parameterId) Sets parameter id.voidsetParameterModel(io.swagger.v3.oas.models.parameters.Parameter parameterModel) Sets parameter model.voidsetParamType(String paramType) Sets param type.voidSets name.voidsetRequestPart(boolean requestPart) Sets request part.voidsetRequired(boolean required) Sets required.
-
Constructor Details
-
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 namemethodParameter- the method parametergenericParameterService- the parameter builderparameterAnnotation- the parameter annotation
-
-
Method Details
-
getpName
Gets name.- Returns:
- the name
-
setpName
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
Gets default value.- Returns:
- the default value
-
setDefaultValue
Sets default value.- Parameters:
defaultValue- the default value
-
getParamType
Gets param type.- Returns:
- the param type
-
setParamType
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
Gets parameter id.- Returns:
- the parameter id
-
setParameterId
Sets parameter id.- Parameters:
parameterId- the parameter id
-