Package org.openapitools.codegen
Class CodegenParameter
- java.lang.Object
-
- org.openapitools.codegen.CodegenParameter
-
- All Implemented Interfaces:
IJsonSchemaValidationProperties
public class CodegenParameter extends Object implements IJsonSchemaValidationProperties
Describes a single operation parameter in the OAS specification. A unique parameter is defined by a combination of a name and location. Parameters may be located in a path, query, header or cookie.
-
-
Field Summary
Fields Modifier and Type Field Description List<String>_enumCodegenPropertyadditionalPropertiesMap<String,Object>allowableValuesStringbaseNameStringbaseTypeStringcollectionFormatStringcontainerTypeStringcontainerTypeMappedStringcontentTypeStringdataFormatStringdataTypeStringdatatypeWithEnumStringdefaultValueStringdescriptionStringenumDefaultValueStringenumNameStringexampleMap<String,io.swagger.v3.oas.models.examples.Example>examplesbooleanexclusiveMaximumSee http://json-schema.org/latest/json-schema-validation.html#anchor17booleanexclusiveMinimumSee http://json-schema.org/latest/json-schema-validation.html#anchor21booleanhasValidationbooleanisAllowEmptyValuebooleanisAnyTypebooleanisArraybooleanisBinarybooleanisBodyParambooleanisBooleanbooleanisByteArraybooleanisCollectionFormatMultibooleanisContainerbooleanisCookieParambooleanisDatebooleanisDateTimebooleanisDecimalbooleanisDeepObjectbooleanisDeprecatedbooleanisDoublebooleanisEmailbooleanisEnumbooleanisEnumRefbooleanisExplodebooleanisFilebooleanisFloatbooleanisFormParambooleanisFreeFormObjectbooleanisHeaderParambooleanisIntegerbooleanisLongbooleanisMapbooleanisMatrixbooleanisModelbooleanisNullbooleanisNullablebooleanisNumberbooleanisNumericbooleanisPasswordbooleanisPathParambooleanisPrimitiveTypebooleanisQueryParambooleanisShortbooleanisStringbooleanisUnboundedIntegerbooleanisUribooleanisUuidbooleanisVoidCodegenPropertyitemsStringjsonSchemaStringmaximumSee http://json-schema.org/latest/json-schema-validation.html#anchor17.IntegermaxItemsSee http://json-schema.org/latest/json-schema-validation.html#anchor42IntegermaxLengthSee http://json-schema.org/latest/json-schema-validation.html#anchor26StringminimumSee http://json-schema.org/latest/json-schema-validation.html#anchor21IntegerminItemsSee http://json-schema.org/latest/json-schema-validation.html#anchor45IntegerminLengthSee http://json-schema.org/latest/json-schema-validation.html#anchor29CodegenPropertymostInnerItemsNumbermultipleOfSee http://json-schema.org/latest/json-schema-validation.html#anchor14StringnameInLowerCaseStringparamNameStringpatternSee http://json-schema.org/latest/json-schema-validation.html#anchor33booleanrequiredDetermines whether this parameter is mandatory.List<CodegenProperty>requiredVarsStringstyleStringunescapedDescriptionbooleanuniqueItemsSee http://json-schema.org/latest/json-schema-validation.html#anchor49List<CodegenProperty>varsMap<String,Object>vendorExtensions
-
Constructor Summary
Constructors Constructor Description CodegenParameter()
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.openapitools.codegen.IJsonSchemaValidationProperties
getComplexType, getImports, setTypeProperties
-
-
-
-
Field Detail
-
isFormParam
public boolean isFormParam
-
isQueryParam
public boolean isQueryParam
-
isPathParam
public boolean isPathParam
-
isHeaderParam
public boolean isHeaderParam
-
isCookieParam
public boolean isCookieParam
-
isBodyParam
public boolean isBodyParam
-
isContainer
public boolean isContainer
-
isCollectionFormatMulti
public boolean isCollectionFormatMulti
-
isPrimitiveType
public boolean isPrimitiveType
-
isModel
public boolean isModel
-
isExplode
public boolean isExplode
-
isDeepObject
public boolean isDeepObject
-
isMatrix
public boolean isMatrix
-
isAllowEmptyValue
public boolean isAllowEmptyValue
-
baseName
public String baseName
-
paramName
public String paramName
-
dataType
public String dataType
-
datatypeWithEnum
public String datatypeWithEnum
-
dataFormat
public String dataFormat
-
contentType
public String contentType
-
collectionFormat
public String collectionFormat
-
description
public String description
-
unescapedDescription
public String unescapedDescription
-
baseType
public String baseType
-
defaultValue
public String defaultValue
-
enumDefaultValue
public String enumDefaultValue
-
enumName
public String enumName
-
style
public String style
-
nameInLowerCase
public String nameInLowerCase
-
example
public String example
-
jsonSchema
public String jsonSchema
-
isString
public boolean isString
-
isNumeric
public boolean isNumeric
-
isInteger
public boolean isInteger
-
isLong
public boolean isLong
-
isNumber
public boolean isNumber
-
isFloat
public boolean isFloat
-
isDouble
public boolean isDouble
-
isDecimal
public boolean isDecimal
-
isByteArray
public boolean isByteArray
-
isBinary
public boolean isBinary
-
isBoolean
public boolean isBoolean
-
isDate
public boolean isDate
-
isDateTime
public boolean isDateTime
-
isUuid
public boolean isUuid
-
isUri
public boolean isUri
-
isEmail
public boolean isEmail
-
isPassword
public boolean isPassword
-
isFreeFormObject
public boolean isFreeFormObject
-
isAnyType
public boolean isAnyType
-
isShort
public boolean isShort
-
isUnboundedInteger
public boolean isUnboundedInteger
-
isArray
public boolean isArray
-
isMap
public boolean isMap
-
isFile
public boolean isFile
-
isEnum
public boolean isEnum
-
isEnumRef
public boolean isEnumRef
-
items
public CodegenProperty items
-
additionalProperties
public CodegenProperty additionalProperties
-
vars
public List<CodegenProperty> vars
-
requiredVars
public List<CodegenProperty> requiredVars
-
mostInnerItems
public CodegenProperty mostInnerItems
-
hasValidation
public boolean hasValidation
-
isNullable
public boolean isNullable
-
isDeprecated
public boolean isDeprecated
-
containerType
public String containerType
-
containerTypeMapped
public String containerTypeMapped
-
required
public boolean required
Determines whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
-
maximum
public String maximum
See http://json-schema.org/latest/json-schema-validation.html#anchor17.
-
exclusiveMaximum
public boolean exclusiveMaximum
See http://json-schema.org/latest/json-schema-validation.html#anchor17
-
minimum
public String minimum
See http://json-schema.org/latest/json-schema-validation.html#anchor21
-
exclusiveMinimum
public boolean exclusiveMinimum
See http://json-schema.org/latest/json-schema-validation.html#anchor21
-
maxLength
public Integer maxLength
See http://json-schema.org/latest/json-schema-validation.html#anchor26
-
minLength
public Integer minLength
See http://json-schema.org/latest/json-schema-validation.html#anchor29
-
pattern
public String pattern
See http://json-schema.org/latest/json-schema-validation.html#anchor33
-
maxItems
public Integer maxItems
See http://json-schema.org/latest/json-schema-validation.html#anchor42
-
minItems
public Integer minItems
See http://json-schema.org/latest/json-schema-validation.html#anchor45
-
uniqueItems
public boolean uniqueItems
See http://json-schema.org/latest/json-schema-validation.html#anchor49
-
multipleOf
public Number multipleOf
See http://json-schema.org/latest/json-schema-validation.html#anchor14
-
isNull
public boolean isNull
-
isVoid
public boolean isVoid
-
-
Method Detail
-
copy
public CodegenParameter copy()
-
getIsEnumOrRef
public boolean getIsEnumOrRef()
Return true if it's an enum (inline or ref)- Returns:
- true if it's an enum (inline or ref)
-
getContains
public CodegenProperty getContains()
- Specified by:
getContainsin interfaceIJsonSchemaValidationProperties
-
setContains
public void setContains(CodegenProperty contains)
- Specified by:
setContainsin interfaceIJsonSchemaValidationProperties
-
getDependentRequired
public LinkedHashMap<String,List<String>> getDependentRequired()
- Specified by:
getDependentRequiredin interfaceIJsonSchemaValidationProperties
-
setDependentRequired
public void setDependentRequired(LinkedHashMap<String,List<String>> dependentRequired)
- Specified by:
setDependentRequiredin interfaceIJsonSchemaValidationProperties
-
getIsBooleanSchemaTrue
public boolean getIsBooleanSchemaTrue()
- Specified by:
getIsBooleanSchemaTruein interfaceIJsonSchemaValidationProperties
-
setIsBooleanSchemaTrue
public void setIsBooleanSchemaTrue(boolean isBooleanSchemaTrue)
- Specified by:
setIsBooleanSchemaTruein interfaceIJsonSchemaValidationProperties
-
getIsBooleanSchemaFalse
public boolean getIsBooleanSchemaFalse()
- Specified by:
getIsBooleanSchemaFalsein interfaceIJsonSchemaValidationProperties
-
setIsBooleanSchemaFalse
public void setIsBooleanSchemaFalse(boolean isBooleanSchemaFalse)
- Specified by:
setIsBooleanSchemaFalsein interfaceIJsonSchemaValidationProperties
-
getFormat
public String getFormat()
- Specified by:
getFormatin interfaceIJsonSchemaValidationProperties
-
setFormat
public void setFormat(String format)
- Specified by:
setFormatin interfaceIJsonSchemaValidationProperties
-
getPattern
public String getPattern()
- Specified by:
getPatternin interfaceIJsonSchemaValidationProperties
-
setPattern
public void setPattern(String pattern)
- Specified by:
setPatternin interfaceIJsonSchemaValidationProperties
-
getMaximum
public String getMaximum()
- Specified by:
getMaximumin interfaceIJsonSchemaValidationProperties
-
setMaximum
public void setMaximum(String maximum)
- Specified by:
setMaximumin interfaceIJsonSchemaValidationProperties
-
getMinimum
public String getMinimum()
- Specified by:
getMinimumin interfaceIJsonSchemaValidationProperties
-
setMinimum
public void setMinimum(String minimum)
- Specified by:
setMinimumin interfaceIJsonSchemaValidationProperties
-
getExclusiveMaximum
public boolean getExclusiveMaximum()
- Specified by:
getExclusiveMaximumin interfaceIJsonSchemaValidationProperties
-
setExclusiveMaximum
public void setExclusiveMaximum(boolean exclusiveMaximum)
- Specified by:
setExclusiveMaximumin interfaceIJsonSchemaValidationProperties
-
getExclusiveMinimum
public boolean getExclusiveMinimum()
- Specified by:
getExclusiveMinimumin interfaceIJsonSchemaValidationProperties
-
setExclusiveMinimum
public void setExclusiveMinimum(boolean exclusiveMinimum)
- Specified by:
setExclusiveMinimumin interfaceIJsonSchemaValidationProperties
-
getMinLength
public Integer getMinLength()
- Specified by:
getMinLengthin interfaceIJsonSchemaValidationProperties
-
setMinLength
public void setMinLength(Integer minLength)
- Specified by:
setMinLengthin interfaceIJsonSchemaValidationProperties
-
getMaxLength
public Integer getMaxLength()
- Specified by:
getMaxLengthin interfaceIJsonSchemaValidationProperties
-
setMaxLength
public void setMaxLength(Integer maxLength)
- Specified by:
setMaxLengthin interfaceIJsonSchemaValidationProperties
-
getMinItems
public Integer getMinItems()
- Specified by:
getMinItemsin interfaceIJsonSchemaValidationProperties
-
setMinItems
public void setMinItems(Integer minItems)
- Specified by:
setMinItemsin interfaceIJsonSchemaValidationProperties
-
getMaxItems
public Integer getMaxItems()
- Specified by:
getMaxItemsin interfaceIJsonSchemaValidationProperties
-
setMaxItems
public void setMaxItems(Integer maxItems)
- Specified by:
setMaxItemsin interfaceIJsonSchemaValidationProperties
-
getUniqueItems
public boolean getUniqueItems()
- Specified by:
getUniqueItemsin interfaceIJsonSchemaValidationProperties
-
setUniqueItems
public void setUniqueItems(boolean uniqueItems)
- Specified by:
setUniqueItemsin interfaceIJsonSchemaValidationProperties
-
getUniqueItemsBoolean
public Boolean getUniqueItemsBoolean()
- Specified by:
getUniqueItemsBooleanin interfaceIJsonSchemaValidationProperties
-
setUniqueItemsBoolean
public void setUniqueItemsBoolean(Boolean uniqueItemsBoolean)
- Specified by:
setUniqueItemsBooleanin interfaceIJsonSchemaValidationProperties
-
getMinProperties
public Integer getMinProperties()
- Specified by:
getMinPropertiesin interfaceIJsonSchemaValidationProperties
-
setMinProperties
public void setMinProperties(Integer minProperties)
- Specified by:
setMinPropertiesin interfaceIJsonSchemaValidationProperties
-
getMaxProperties
public Integer getMaxProperties()
- Specified by:
getMaxPropertiesin interfaceIJsonSchemaValidationProperties
-
setMaxProperties
public void setMaxProperties(Integer maxProperties)
- Specified by:
setMaxPropertiesin interfaceIJsonSchemaValidationProperties
-
getMultipleOf
public Number getMultipleOf()
- Specified by:
getMultipleOfin interfaceIJsonSchemaValidationProperties
-
setMultipleOf
public void setMultipleOf(Number multipleOf)
- Specified by:
setMultipleOfin interfaceIJsonSchemaValidationProperties
-
getItems
public CodegenProperty getItems()
- Specified by:
getItemsin interfaceIJsonSchemaValidationProperties
-
setItems
public void setItems(CodegenProperty items)
- Specified by:
setItemsin interfaceIJsonSchemaValidationProperties
-
getIsModel
public boolean getIsModel()
- Specified by:
getIsModelin interfaceIJsonSchemaValidationProperties
-
setIsModel
public void setIsModel(boolean isModel)
- Specified by:
setIsModelin interfaceIJsonSchemaValidationProperties
-
getIsDate
public boolean getIsDate()
- Specified by:
getIsDatein interfaceIJsonSchemaValidationProperties
-
setIsDate
public void setIsDate(boolean isDate)
- Specified by:
setIsDatein interfaceIJsonSchemaValidationProperties
-
getIsDateTime
public boolean getIsDateTime()
- Specified by:
getIsDateTimein interfaceIJsonSchemaValidationProperties
-
setIsDateTime
public void setIsDateTime(boolean isDateTime)
- Specified by:
setIsDateTimein interfaceIJsonSchemaValidationProperties
-
getIsMap
public boolean getIsMap()
- Specified by:
getIsMapin interfaceIJsonSchemaValidationProperties
-
setIsMap
public void setIsMap(boolean isMap)
- Specified by:
setIsMapin interfaceIJsonSchemaValidationProperties
-
getIsArray
public boolean getIsArray()
- Specified by:
getIsArrayin interfaceIJsonSchemaValidationProperties
-
setIsArray
public void setIsArray(boolean isArray)
- Specified by:
setIsArrayin interfaceIJsonSchemaValidationProperties
-
getIsShort
public boolean getIsShort()
- Specified by:
getIsShortin interfaceIJsonSchemaValidationProperties
-
setIsShort
public void setIsShort(boolean isShort)
- Specified by:
setIsShortin interfaceIJsonSchemaValidationProperties
-
getIsBoolean
public boolean getIsBoolean()
- Specified by:
getIsBooleanin interfaceIJsonSchemaValidationProperties
-
setIsBoolean
public void setIsBoolean(boolean isBoolean)
- Specified by:
setIsBooleanin interfaceIJsonSchemaValidationProperties
-
getIsUnboundedInteger
public boolean getIsUnboundedInteger()
- Specified by:
getIsUnboundedIntegerin interfaceIJsonSchemaValidationProperties
-
setIsUnboundedInteger
public void setIsUnboundedInteger(boolean isUnboundedInteger)
- Specified by:
setIsUnboundedIntegerin interfaceIJsonSchemaValidationProperties
-
getIsPrimitiveType
public boolean getIsPrimitiveType()
- Specified by:
getIsPrimitiveTypein interfaceIJsonSchemaValidationProperties
-
setIsPrimitiveType
public void setIsPrimitiveType(boolean isPrimitiveType)
- Specified by:
setIsPrimitiveTypein interfaceIJsonSchemaValidationProperties
-
getAdditionalProperties
public CodegenProperty getAdditionalProperties()
- Specified by:
getAdditionalPropertiesin interfaceIJsonSchemaValidationProperties
-
setAdditionalProperties
public void setAdditionalProperties(CodegenProperty additionalProperties)
- Specified by:
setAdditionalPropertiesin interfaceIJsonSchemaValidationProperties
-
getVars
public List<CodegenProperty> getVars()
- Specified by:
getVarsin interfaceIJsonSchemaValidationProperties
-
setVars
public void setVars(List<CodegenProperty> vars)
- Specified by:
setVarsin interfaceIJsonSchemaValidationProperties
-
getRequiredVars
public List<CodegenProperty> getRequiredVars()
- Specified by:
getRequiredVarsin interfaceIJsonSchemaValidationProperties
-
setRequiredVars
public void setRequiredVars(List<CodegenProperty> requiredVars)
- Specified by:
setRequiredVarsin interfaceIJsonSchemaValidationProperties
-
requiredAndNotNullable
public boolean requiredAndNotNullable()
-
notRequiredOrIsNullable
public boolean notRequiredOrIsNullable()
-
getIsNull
public boolean getIsNull()
- Specified by:
getIsNullin interfaceIJsonSchemaValidationProperties
-
setIsNull
public void setIsNull(boolean isNull)
- Specified by:
setIsNullin interfaceIJsonSchemaValidationProperties
-
getIsVoid
public boolean getIsVoid()
- Specified by:
getIsVoidin interfaceIJsonSchemaValidationProperties
-
setIsVoid
public void setIsVoid(boolean isVoid)
- Specified by:
setIsVoidin interfaceIJsonSchemaValidationProperties
-
getHasValidation
public boolean getHasValidation()
- Specified by:
getHasValidationin interfaceIJsonSchemaValidationProperties
-
setHasValidation
public void setHasValidation(boolean hasValidation)
- Specified by:
setHasValidationin interfaceIJsonSchemaValidationProperties
-
getAdditionalPropertiesIsAnyType
public boolean getAdditionalPropertiesIsAnyType()
- Specified by:
getAdditionalPropertiesIsAnyTypein interfaceIJsonSchemaValidationProperties
-
setAdditionalPropertiesIsAnyType
public void setAdditionalPropertiesIsAnyType(boolean additionalPropertiesIsAnyType)
- Specified by:
setAdditionalPropertiesIsAnyTypein interfaceIJsonSchemaValidationProperties
-
getHasVars
public boolean getHasVars()
- Specified by:
getHasVarsin interfaceIJsonSchemaValidationProperties
-
setHasVars
public void setHasVars(boolean hasVars)
- Specified by:
setHasVarsin interfaceIJsonSchemaValidationProperties
-
getHasRequired
public boolean getHasRequired()
- Specified by:
getHasRequiredin interfaceIJsonSchemaValidationProperties
-
setHasRequired
public void setHasRequired(boolean hasRequired)
- Specified by:
setHasRequiredin interfaceIJsonSchemaValidationProperties
-
getHasDiscriminatorWithNonEmptyMapping
public boolean getHasDiscriminatorWithNonEmptyMapping()
- Specified by:
getHasDiscriminatorWithNonEmptyMappingin interfaceIJsonSchemaValidationProperties
-
setHasDiscriminatorWithNonEmptyMapping
public void setHasDiscriminatorWithNonEmptyMapping(boolean hasDiscriminatorWithNonEmptyMapping)
- Specified by:
setHasDiscriminatorWithNonEmptyMappingin interfaceIJsonSchemaValidationProperties
-
getIsString
public boolean getIsString()
- Specified by:
getIsStringin interfaceIJsonSchemaValidationProperties
-
setIsString
public void setIsString(boolean isString)
- Specified by:
setIsStringin interfaceIJsonSchemaValidationProperties
-
getIsNumber
public boolean getIsNumber()
- Specified by:
getIsNumberin interfaceIJsonSchemaValidationProperties
-
setIsNumber
public void setIsNumber(boolean isNumber)
- Specified by:
setIsNumberin interfaceIJsonSchemaValidationProperties
-
getIsAnyType
public boolean getIsAnyType()
- Specified by:
getIsAnyTypein interfaceIJsonSchemaValidationProperties
-
setIsAnyType
public void setIsAnyType(boolean isAnyType)
- Specified by:
setIsAnyTypein interfaceIJsonSchemaValidationProperties
-
getIsFreeFormObject
public boolean getIsFreeFormObject()
- Specified by:
getIsFreeFormObjectin interfaceIJsonSchemaValidationProperties
-
setIsFreeFormObject
public void setIsFreeFormObject(boolean isFreeFormObject)
- Specified by:
setIsFreeFormObjectin interfaceIJsonSchemaValidationProperties
-
setComposedSchemas
public void setComposedSchemas(CodegenComposedSchemas composedSchemas)
- Specified by:
setComposedSchemasin interfaceIJsonSchemaValidationProperties
-
getComposedSchemas
public CodegenComposedSchemas getComposedSchemas()
- Specified by:
getComposedSchemasin interfaceIJsonSchemaValidationProperties
-
getHasMultipleTypes
public boolean getHasMultipleTypes()
- Specified by:
getHasMultipleTypesin interfaceIJsonSchemaValidationProperties
-
setHasMultipleTypes
public void setHasMultipleTypes(boolean hasMultipleTypes)
- Specified by:
setHasMultipleTypesin interfaceIJsonSchemaValidationProperties
-
getSchema
public CodegenProperty getSchema()
-
setSchema
public void setSchema(CodegenProperty schema)
-
getContent
public LinkedHashMap<String,CodegenMediaType> getContent()
-
setContent
public void setContent(LinkedHashMap<String,CodegenMediaType> content)
-
getBaseType
public String getBaseType()
- Specified by:
getBaseTypein interfaceIJsonSchemaValidationProperties- Returns:
- basic type - no generics supported.
-
getRequiredVarsMap
public Map<String,CodegenProperty> getRequiredVarsMap()
- Specified by:
getRequiredVarsMapin interfaceIJsonSchemaValidationProperties
-
setRequiredVarsMap
public void setRequiredVarsMap(Map<String,CodegenProperty> requiredVarsMap)
- Specified by:
setRequiredVarsMapin interfaceIJsonSchemaValidationProperties
-
getRef
public String getRef()
- Specified by:
getRefin interfaceIJsonSchemaValidationProperties
-
setRef
public void setRef(String ref)
- Specified by:
setRefin interfaceIJsonSchemaValidationProperties
-
getSchemaIsFromAdditionalProperties
public boolean getSchemaIsFromAdditionalProperties()
- Specified by:
getSchemaIsFromAdditionalPropertiesin interfaceIJsonSchemaValidationProperties
-
setSchemaIsFromAdditionalProperties
public void setSchemaIsFromAdditionalProperties(boolean schemaIsFromAdditionalProperties)
- Specified by:
setSchemaIsFromAdditionalPropertiesin interfaceIJsonSchemaValidationProperties
-
-