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>
_enum
CodegenProperty
additionalProperties
Map<String,Object>
allowableValues
String
baseName
String
baseType
String
collectionFormat
String
containerType
String
containerTypeMapped
String
contentType
String
dataFormat
String
dataType
String
datatypeWithEnum
String
defaultValue
String
description
String
enumDefaultValue
String
enumName
String
example
Map<String,io.swagger.v3.oas.models.examples.Example>
examples
boolean
exclusiveMaximum
See http://json-schema.org/latest/json-schema-validation.html#anchor17boolean
exclusiveMinimum
See http://json-schema.org/latest/json-schema-validation.html#anchor21boolean
hasValidation
boolean
isAllowEmptyValue
boolean
isAnyType
boolean
isArray
boolean
isBinary
boolean
isBodyParam
boolean
isBoolean
boolean
isByteArray
boolean
isCollectionFormatMulti
boolean
isContainer
boolean
isCookieParam
boolean
isDate
boolean
isDateTime
boolean
isDecimal
boolean
isDeepObject
boolean
isDeprecated
boolean
isDouble
boolean
isEmail
boolean
isEnum
boolean
isEnumRef
boolean
isExplode
boolean
isFile
boolean
isFloat
boolean
isFormParam
boolean
isFreeFormObject
boolean
isHeaderParam
boolean
isInteger
boolean
isLong
boolean
isMap
boolean
isMatrix
boolean
isModel
boolean
isNull
boolean
isNullable
boolean
isNumber
boolean
isNumeric
boolean
isPassword
boolean
isPathParam
boolean
isPrimitiveType
boolean
isQueryParam
boolean
isShort
boolean
isString
boolean
isUnboundedInteger
boolean
isUri
boolean
isUuid
boolean
isVoid
CodegenProperty
items
String
jsonSchema
String
maximum
See http://json-schema.org/latest/json-schema-validation.html#anchor17.Integer
maxItems
See http://json-schema.org/latest/json-schema-validation.html#anchor42Integer
maxLength
See http://json-schema.org/latest/json-schema-validation.html#anchor26String
minimum
See http://json-schema.org/latest/json-schema-validation.html#anchor21Integer
minItems
See http://json-schema.org/latest/json-schema-validation.html#anchor45Integer
minLength
See http://json-schema.org/latest/json-schema-validation.html#anchor29CodegenProperty
mostInnerItems
Number
multipleOf
See http://json-schema.org/latest/json-schema-validation.html#anchor14String
nameInLowerCase
String
paramName
String
pattern
See http://json-schema.org/latest/json-schema-validation.html#anchor33boolean
required
Determines whether this parameter is mandatory.List<CodegenProperty>
requiredVars
String
style
String
unescapedDescription
boolean
uniqueItems
See http://json-schema.org/latest/json-schema-validation.html#anchor49List<CodegenProperty>
vars
Map<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:
getContains
in interfaceIJsonSchemaValidationProperties
-
setContains
public void setContains(CodegenProperty contains)
- Specified by:
setContains
in interfaceIJsonSchemaValidationProperties
-
getDependentRequired
public LinkedHashMap<String,List<String>> getDependentRequired()
- Specified by:
getDependentRequired
in interfaceIJsonSchemaValidationProperties
-
setDependentRequired
public void setDependentRequired(LinkedHashMap<String,List<String>> dependentRequired)
- Specified by:
setDependentRequired
in interfaceIJsonSchemaValidationProperties
-
getIsBooleanSchemaTrue
public boolean getIsBooleanSchemaTrue()
- Specified by:
getIsBooleanSchemaTrue
in interfaceIJsonSchemaValidationProperties
-
setIsBooleanSchemaTrue
public void setIsBooleanSchemaTrue(boolean isBooleanSchemaTrue)
- Specified by:
setIsBooleanSchemaTrue
in interfaceIJsonSchemaValidationProperties
-
getIsBooleanSchemaFalse
public boolean getIsBooleanSchemaFalse()
- Specified by:
getIsBooleanSchemaFalse
in interfaceIJsonSchemaValidationProperties
-
setIsBooleanSchemaFalse
public void setIsBooleanSchemaFalse(boolean isBooleanSchemaFalse)
- Specified by:
setIsBooleanSchemaFalse
in interfaceIJsonSchemaValidationProperties
-
getFormat
public String getFormat()
- Specified by:
getFormat
in interfaceIJsonSchemaValidationProperties
-
setFormat
public void setFormat(String format)
- Specified by:
setFormat
in interfaceIJsonSchemaValidationProperties
-
getPattern
public String getPattern()
- Specified by:
getPattern
in interfaceIJsonSchemaValidationProperties
-
setPattern
public void setPattern(String pattern)
- Specified by:
setPattern
in interfaceIJsonSchemaValidationProperties
-
getMaximum
public String getMaximum()
- Specified by:
getMaximum
in interfaceIJsonSchemaValidationProperties
-
setMaximum
public void setMaximum(String maximum)
- Specified by:
setMaximum
in interfaceIJsonSchemaValidationProperties
-
getMinimum
public String getMinimum()
- Specified by:
getMinimum
in interfaceIJsonSchemaValidationProperties
-
setMinimum
public void setMinimum(String minimum)
- Specified by:
setMinimum
in interfaceIJsonSchemaValidationProperties
-
getExclusiveMaximum
public boolean getExclusiveMaximum()
- Specified by:
getExclusiveMaximum
in interfaceIJsonSchemaValidationProperties
-
setExclusiveMaximum
public void setExclusiveMaximum(boolean exclusiveMaximum)
- Specified by:
setExclusiveMaximum
in interfaceIJsonSchemaValidationProperties
-
getExclusiveMinimum
public boolean getExclusiveMinimum()
- Specified by:
getExclusiveMinimum
in interfaceIJsonSchemaValidationProperties
-
setExclusiveMinimum
public void setExclusiveMinimum(boolean exclusiveMinimum)
- Specified by:
setExclusiveMinimum
in interfaceIJsonSchemaValidationProperties
-
getMinLength
public Integer getMinLength()
- Specified by:
getMinLength
in interfaceIJsonSchemaValidationProperties
-
setMinLength
public void setMinLength(Integer minLength)
- Specified by:
setMinLength
in interfaceIJsonSchemaValidationProperties
-
getMaxLength
public Integer getMaxLength()
- Specified by:
getMaxLength
in interfaceIJsonSchemaValidationProperties
-
setMaxLength
public void setMaxLength(Integer maxLength)
- Specified by:
setMaxLength
in interfaceIJsonSchemaValidationProperties
-
getMinItems
public Integer getMinItems()
- Specified by:
getMinItems
in interfaceIJsonSchemaValidationProperties
-
setMinItems
public void setMinItems(Integer minItems)
- Specified by:
setMinItems
in interfaceIJsonSchemaValidationProperties
-
getMaxItems
public Integer getMaxItems()
- Specified by:
getMaxItems
in interfaceIJsonSchemaValidationProperties
-
setMaxItems
public void setMaxItems(Integer maxItems)
- Specified by:
setMaxItems
in interfaceIJsonSchemaValidationProperties
-
getUniqueItems
public boolean getUniqueItems()
- Specified by:
getUniqueItems
in interfaceIJsonSchemaValidationProperties
-
setUniqueItems
public void setUniqueItems(boolean uniqueItems)
- Specified by:
setUniqueItems
in interfaceIJsonSchemaValidationProperties
-
getUniqueItemsBoolean
public Boolean getUniqueItemsBoolean()
- Specified by:
getUniqueItemsBoolean
in interfaceIJsonSchemaValidationProperties
-
setUniqueItemsBoolean
public void setUniqueItemsBoolean(Boolean uniqueItemsBoolean)
- Specified by:
setUniqueItemsBoolean
in interfaceIJsonSchemaValidationProperties
-
getMinProperties
public Integer getMinProperties()
- Specified by:
getMinProperties
in interfaceIJsonSchemaValidationProperties
-
setMinProperties
public void setMinProperties(Integer minProperties)
- Specified by:
setMinProperties
in interfaceIJsonSchemaValidationProperties
-
getMaxProperties
public Integer getMaxProperties()
- Specified by:
getMaxProperties
in interfaceIJsonSchemaValidationProperties
-
setMaxProperties
public void setMaxProperties(Integer maxProperties)
- Specified by:
setMaxProperties
in interfaceIJsonSchemaValidationProperties
-
getMultipleOf
public Number getMultipleOf()
- Specified by:
getMultipleOf
in interfaceIJsonSchemaValidationProperties
-
setMultipleOf
public void setMultipleOf(Number multipleOf)
- Specified by:
setMultipleOf
in interfaceIJsonSchemaValidationProperties
-
getItems
public CodegenProperty getItems()
- Specified by:
getItems
in interfaceIJsonSchemaValidationProperties
-
setItems
public void setItems(CodegenProperty items)
- Specified by:
setItems
in interfaceIJsonSchemaValidationProperties
-
getIsModel
public boolean getIsModel()
- Specified by:
getIsModel
in interfaceIJsonSchemaValidationProperties
-
setIsModel
public void setIsModel(boolean isModel)
- Specified by:
setIsModel
in interfaceIJsonSchemaValidationProperties
-
getIsDate
public boolean getIsDate()
- Specified by:
getIsDate
in interfaceIJsonSchemaValidationProperties
-
setIsDate
public void setIsDate(boolean isDate)
- Specified by:
setIsDate
in interfaceIJsonSchemaValidationProperties
-
getIsDateTime
public boolean getIsDateTime()
- Specified by:
getIsDateTime
in interfaceIJsonSchemaValidationProperties
-
setIsDateTime
public void setIsDateTime(boolean isDateTime)
- Specified by:
setIsDateTime
in interfaceIJsonSchemaValidationProperties
-
getIsMap
public boolean getIsMap()
- Specified by:
getIsMap
in interfaceIJsonSchemaValidationProperties
-
setIsMap
public void setIsMap(boolean isMap)
- Specified by:
setIsMap
in interfaceIJsonSchemaValidationProperties
-
getIsArray
public boolean getIsArray()
- Specified by:
getIsArray
in interfaceIJsonSchemaValidationProperties
-
setIsArray
public void setIsArray(boolean isArray)
- Specified by:
setIsArray
in interfaceIJsonSchemaValidationProperties
-
getIsShort
public boolean getIsShort()
- Specified by:
getIsShort
in interfaceIJsonSchemaValidationProperties
-
setIsShort
public void setIsShort(boolean isShort)
- Specified by:
setIsShort
in interfaceIJsonSchemaValidationProperties
-
getIsBoolean
public boolean getIsBoolean()
- Specified by:
getIsBoolean
in interfaceIJsonSchemaValidationProperties
-
setIsBoolean
public void setIsBoolean(boolean isBoolean)
- Specified by:
setIsBoolean
in interfaceIJsonSchemaValidationProperties
-
getIsUnboundedInteger
public boolean getIsUnboundedInteger()
- Specified by:
getIsUnboundedInteger
in interfaceIJsonSchemaValidationProperties
-
setIsUnboundedInteger
public void setIsUnboundedInteger(boolean isUnboundedInteger)
- Specified by:
setIsUnboundedInteger
in interfaceIJsonSchemaValidationProperties
-
getIsPrimitiveType
public boolean getIsPrimitiveType()
- Specified by:
getIsPrimitiveType
in interfaceIJsonSchemaValidationProperties
-
setIsPrimitiveType
public void setIsPrimitiveType(boolean isPrimitiveType)
- Specified by:
setIsPrimitiveType
in interfaceIJsonSchemaValidationProperties
-
getAdditionalProperties
public CodegenProperty getAdditionalProperties()
- Specified by:
getAdditionalProperties
in interfaceIJsonSchemaValidationProperties
-
setAdditionalProperties
public void setAdditionalProperties(CodegenProperty additionalProperties)
- Specified by:
setAdditionalProperties
in interfaceIJsonSchemaValidationProperties
-
getVars
public List<CodegenProperty> getVars()
- Specified by:
getVars
in interfaceIJsonSchemaValidationProperties
-
setVars
public void setVars(List<CodegenProperty> vars)
- Specified by:
setVars
in interfaceIJsonSchemaValidationProperties
-
getRequiredVars
public List<CodegenProperty> getRequiredVars()
- Specified by:
getRequiredVars
in interfaceIJsonSchemaValidationProperties
-
setRequiredVars
public void setRequiredVars(List<CodegenProperty> requiredVars)
- Specified by:
setRequiredVars
in interfaceIJsonSchemaValidationProperties
-
requiredAndNotNullable
public boolean requiredAndNotNullable()
-
notRequiredOrIsNullable
public boolean notRequiredOrIsNullable()
-
getIsNull
public boolean getIsNull()
- Specified by:
getIsNull
in interfaceIJsonSchemaValidationProperties
-
setIsNull
public void setIsNull(boolean isNull)
- Specified by:
setIsNull
in interfaceIJsonSchemaValidationProperties
-
getIsVoid
public boolean getIsVoid()
- Specified by:
getIsVoid
in interfaceIJsonSchemaValidationProperties
-
setIsVoid
public void setIsVoid(boolean isVoid)
- Specified by:
setIsVoid
in interfaceIJsonSchemaValidationProperties
-
getHasValidation
public boolean getHasValidation()
- Specified by:
getHasValidation
in interfaceIJsonSchemaValidationProperties
-
setHasValidation
public void setHasValidation(boolean hasValidation)
- Specified by:
setHasValidation
in interfaceIJsonSchemaValidationProperties
-
getAdditionalPropertiesIsAnyType
public boolean getAdditionalPropertiesIsAnyType()
- Specified by:
getAdditionalPropertiesIsAnyType
in interfaceIJsonSchemaValidationProperties
-
setAdditionalPropertiesIsAnyType
public void setAdditionalPropertiesIsAnyType(boolean additionalPropertiesIsAnyType)
- Specified by:
setAdditionalPropertiesIsAnyType
in interfaceIJsonSchemaValidationProperties
-
getHasVars
public boolean getHasVars()
- Specified by:
getHasVars
in interfaceIJsonSchemaValidationProperties
-
setHasVars
public void setHasVars(boolean hasVars)
- Specified by:
setHasVars
in interfaceIJsonSchemaValidationProperties
-
getHasRequired
public boolean getHasRequired()
- Specified by:
getHasRequired
in interfaceIJsonSchemaValidationProperties
-
setHasRequired
public void setHasRequired(boolean hasRequired)
- Specified by:
setHasRequired
in interfaceIJsonSchemaValidationProperties
-
getHasDiscriminatorWithNonEmptyMapping
public boolean getHasDiscriminatorWithNonEmptyMapping()
- Specified by:
getHasDiscriminatorWithNonEmptyMapping
in interfaceIJsonSchemaValidationProperties
-
setHasDiscriminatorWithNonEmptyMapping
public void setHasDiscriminatorWithNonEmptyMapping(boolean hasDiscriminatorWithNonEmptyMapping)
- Specified by:
setHasDiscriminatorWithNonEmptyMapping
in interfaceIJsonSchemaValidationProperties
-
getIsString
public boolean getIsString()
- Specified by:
getIsString
in interfaceIJsonSchemaValidationProperties
-
setIsString
public void setIsString(boolean isString)
- Specified by:
setIsString
in interfaceIJsonSchemaValidationProperties
-
getIsNumber
public boolean getIsNumber()
- Specified by:
getIsNumber
in interfaceIJsonSchemaValidationProperties
-
setIsNumber
public void setIsNumber(boolean isNumber)
- Specified by:
setIsNumber
in interfaceIJsonSchemaValidationProperties
-
getIsAnyType
public boolean getIsAnyType()
- Specified by:
getIsAnyType
in interfaceIJsonSchemaValidationProperties
-
setIsAnyType
public void setIsAnyType(boolean isAnyType)
- Specified by:
setIsAnyType
in interfaceIJsonSchemaValidationProperties
-
getIsFreeFormObject
public boolean getIsFreeFormObject()
- Specified by:
getIsFreeFormObject
in interfaceIJsonSchemaValidationProperties
-
setIsFreeFormObject
public void setIsFreeFormObject(boolean isFreeFormObject)
- Specified by:
setIsFreeFormObject
in interfaceIJsonSchemaValidationProperties
-
setComposedSchemas
public void setComposedSchemas(CodegenComposedSchemas composedSchemas)
- Specified by:
setComposedSchemas
in interfaceIJsonSchemaValidationProperties
-
getComposedSchemas
public CodegenComposedSchemas getComposedSchemas()
- Specified by:
getComposedSchemas
in interfaceIJsonSchemaValidationProperties
-
getHasMultipleTypes
public boolean getHasMultipleTypes()
- Specified by:
getHasMultipleTypes
in interfaceIJsonSchemaValidationProperties
-
setHasMultipleTypes
public void setHasMultipleTypes(boolean hasMultipleTypes)
- Specified by:
setHasMultipleTypes
in 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:
getBaseType
in interfaceIJsonSchemaValidationProperties
- Returns:
- basic type - no generics supported.
-
getRequiredVarsMap
public Map<String,CodegenProperty> getRequiredVarsMap()
- Specified by:
getRequiredVarsMap
in interfaceIJsonSchemaValidationProperties
-
setRequiredVarsMap
public void setRequiredVarsMap(Map<String,CodegenProperty> requiredVarsMap)
- Specified by:
setRequiredVarsMap
in interfaceIJsonSchemaValidationProperties
-
getRef
public String getRef()
- Specified by:
getRef
in interfaceIJsonSchemaValidationProperties
-
setRef
public void setRef(String ref)
- Specified by:
setRef
in interfaceIJsonSchemaValidationProperties
-
getSchemaIsFromAdditionalProperties
public boolean getSchemaIsFromAdditionalProperties()
- Specified by:
getSchemaIsFromAdditionalProperties
in interfaceIJsonSchemaValidationProperties
-
setSchemaIsFromAdditionalProperties
public void setSchemaIsFromAdditionalProperties(boolean schemaIsFromAdditionalProperties)
- Specified by:
setSchemaIsFromAdditionalProperties
in interfaceIJsonSchemaValidationProperties
-
-