Package org.openapitools.codegen
Interface IJsonSchemaValidationProperties
-
- All Known Implementing Classes:
CodegenModel,CodegenParameter,CodegenProperty,CodegenResponse,TypeScriptFetchClientCodegen.ExtendedCodegenModel,TypeScriptFetchClientCodegen.ExtendedCodegenParameter,TypeScriptFetchClientCodegen.ExtendedCodegenProperty
public interface IJsonSchemaValidationProperties
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CodegenPropertygetAdditionalProperties()booleangetAdditionalPropertiesIsAnyType()default StringgetBaseType()default StringgetComplexType()CodegenComposedSchemasgetComposedSchemas()CodegenPropertygetContains()StringgetDataType()LinkedHashMap<String,List<String>>getDependentRequired()booleangetExclusiveMaximum()booleangetExclusiveMinimum()StringgetFormat()booleangetHasDiscriminatorWithNonEmptyMapping()booleangetHasMultipleTypes()booleangetHasRequired()booleangetHasValidation()booleangetHasVars()default Set<String>getImports(boolean importContainerType, boolean importBaseType, FeatureSet featureSet)Recursively collect all necessary imports to include so that the type may be resolved.booleangetIsAnyType()booleangetIsArray()booleangetIsBinary()booleangetIsBoolean()booleangetIsBooleanSchemaFalse()booleangetIsBooleanSchemaTrue()booleangetIsByteArray()booleangetIsDate()booleangetIsDateTime()booleangetIsDecimal()booleangetIsDouble()booleangetIsEnum()booleangetIsFloat()booleangetIsFreeFormObject()booleangetIsInteger()booleangetIsLong()booleangetIsMap()booleangetIsModel()booleangetIsNull()booleangetIsNumber()booleangetIsOptional()Tells if the datatype is a generic inner parameter of astd::optionalfor C++, orOptional(Java)
to resolve cases (detected in issue #6726) where :
-categoryOneOfis a parameter of classGetAccountVideos_categoryOneOf_parameter, a model parameter that correctly prefixed by its namespace:org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter
- but thatGetAccountVideos_categoryOneOf_parameterclass is inside anstd::optional
Then a correct generation of that parameter can be (for C++)const std::optional<org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter> &categoryOneOf
but using #isModel alone without #isOptional in mustache might produceconst org::openapitools::server::model::std::optional<org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter> &categoryOneOfinstead, that do not compile.booleangetIsPrimitiveType()booleangetIsShort()booleangetIsString()booleangetIsUnboundedInteger()booleangetIsUuid()booleangetIsVoid()CodegenPropertygetItems()StringgetMaximum()IntegergetMaxItems()IntegergetMaxLength()IntegergetMaxProperties()StringgetMinimum()IntegergetMinItems()IntegergetMinLength()IntegergetMinProperties()NumbergetMultipleOf()StringgetPattern()StringgetRef()List<CodegenProperty>getRequiredVars()Map<String,CodegenProperty>getRequiredVarsMap()booleangetSchemaIsFromAdditionalProperties()booleangetUniqueItems()BooleangetUniqueItemsBoolean()List<CodegenProperty>getVars()voidsetAdditionalProperties(CodegenProperty additionalProperties)voidsetAdditionalPropertiesIsAnyType(boolean additionalPropertiesIsAnyType)voidsetComposedSchemas(CodegenComposedSchemas composedSchemas)voidsetContains(CodegenProperty contains)voidsetDataType(String dataType)voidsetDependentRequired(LinkedHashMap<String,List<String>> dependentRequired)voidsetExclusiveMaximum(boolean exclusiveMaximum)voidsetExclusiveMinimum(boolean exclusiveMinimum)voidsetFormat(String format)voidsetHasDiscriminatorWithNonEmptyMapping(boolean hasDiscriminatorWithNonEmptyMapping)voidsetHasMultipleTypes(boolean hasMultipleTypes)voidsetHasRequired(boolean hasRequired)voidsetHasValidation(boolean hasValidation)voidsetHasVars(boolean hasVars)voidsetIsAnyType(boolean isAnyType)voidsetIsArray(boolean isArray)voidsetIsBinary(boolean isBinary)voidsetIsBoolean(boolean isBoolean)voidsetIsBooleanSchemaFalse(boolean isBooleanSchemaFalse)voidsetIsBooleanSchemaTrue(boolean isBooleanSchemaTrue)voidsetIsByteArray(boolean isByteArray)voidsetIsDate(boolean isDate)voidsetIsDateTime(boolean isDateTime)voidsetIsDecimal(boolean isDecimal)voidsetIsDouble(boolean isDouble)voidsetIsEnum(boolean isEnum)voidsetIsFloat(boolean isFloat)voidsetIsFreeFormObject(boolean isFreeFormObject)voidsetIsInteger(boolean isInteger)voidsetIsLong(boolean isLong)voidsetIsMap(boolean isMap)voidsetIsModel(boolean isModel)voidsetIsNull(boolean isNull)voidsetIsNumber(boolean isNumber)voidsetIsOptional(boolean isOptional)voidsetIsPrimitiveType(boolean isPrimitiveType)voidsetIsShort(boolean isShort)voidsetIsString(boolean isString)voidsetIsUnboundedInteger(boolean isUnboundedInteger)voidsetIsUuid(boolean isUuid)voidsetIsVoid(boolean isVoid)voidsetItems(CodegenProperty items)voidsetMaximum(String maximum)voidsetMaxItems(Integer maxItems)voidsetMaxLength(Integer maxLength)voidsetMaxProperties(Integer maxProperties)voidsetMinimum(String minimum)voidsetMinItems(Integer minItems)voidsetMinLength(Integer minLength)voidsetMinProperties(Integer minProperties)voidsetMultipleOf(Number multipleOf)voidsetPattern(String pattern)voidsetRef(String ref)voidsetRequiredVars(List<CodegenProperty> requiredVars)voidsetRequiredVarsMap(Map<String,CodegenProperty> requiredVarsMap)voidsetSchemaIsFromAdditionalProperties(boolean schemaIsFromAdditionalProperties)default voidsetTypeProperties(io.swagger.v3.oas.models.media.Schema p)Syncs all the schema's type properties into the IJsonSchemaValidationProperties instance for now this only supports types without format information TODO: in the future move the format handling in here toovoidsetUniqueItems(boolean uniqueItems)voidsetUniqueItemsBoolean(Boolean uniqueItems)voidsetVars(List<CodegenProperty> vars)
-
-
-
Method Detail
-
getContains
CodegenProperty getContains()
-
setContains
void setContains(CodegenProperty contains)
-
getDependentRequired
LinkedHashMap<String,List<String>> getDependentRequired()
-
setDependentRequired
void setDependentRequired(LinkedHashMap<String,List<String>> dependentRequired)
-
getPattern
String getPattern()
-
setPattern
void setPattern(String pattern)
-
getMaximum
String getMaximum()
-
setMaximum
void setMaximum(String maximum)
-
getMinimum
String getMinimum()
-
setMinimum
void setMinimum(String minimum)
-
getExclusiveMaximum
boolean getExclusiveMaximum()
-
setExclusiveMaximum
void setExclusiveMaximum(boolean exclusiveMaximum)
-
getExclusiveMinimum
boolean getExclusiveMinimum()
-
setExclusiveMinimum
void setExclusiveMinimum(boolean exclusiveMinimum)
-
getMinLength
Integer getMinLength()
-
setMinLength
void setMinLength(Integer minLength)
-
getMaxLength
Integer getMaxLength()
-
setMaxLength
void setMaxLength(Integer maxLength)
-
getMinItems
Integer getMinItems()
-
setMinItems
void setMinItems(Integer minItems)
-
getMaxItems
Integer getMaxItems()
-
setMaxItems
void setMaxItems(Integer maxItems)
-
getUniqueItems
boolean getUniqueItems()
-
setUniqueItems
void setUniqueItems(boolean uniqueItems)
-
getUniqueItemsBoolean
Boolean getUniqueItemsBoolean()
-
setUniqueItemsBoolean
void setUniqueItemsBoolean(Boolean uniqueItems)
-
getMinProperties
Integer getMinProperties()
-
setMinProperties
void setMinProperties(Integer minProperties)
-
getMaxProperties
Integer getMaxProperties()
-
setMaxProperties
void setMaxProperties(Integer maxProperties)
-
getMultipleOf
Number getMultipleOf()
-
setMultipleOf
void setMultipleOf(Number multipleOf)
-
getItems
CodegenProperty getItems()
-
setItems
void setItems(CodegenProperty items)
-
getIsModel
boolean getIsModel()
-
setIsModel
void setIsModel(boolean isModel)
-
getIsDate
boolean getIsDate()
-
setIsDate
void setIsDate(boolean isDate)
-
getIsDateTime
boolean getIsDateTime()
-
setIsDateTime
void setIsDateTime(boolean isDateTime)
-
getIsMap
boolean getIsMap()
-
setIsMap
void setIsMap(boolean isMap)
-
getIsOptional
boolean getIsOptional()
Tells if the datatype is a generic inner parameter of astd::optionalfor C++, orOptional(Java)
to resolve cases (detected in issue #6726) where :
-categoryOneOfis a parameter of classGetAccountVideos_categoryOneOf_parameter, a model parameter that correctly prefixed by its namespace:org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter
- but thatGetAccountVideos_categoryOneOf_parameterclass is inside anstd::optional
Then a correct generation of that parameter can be (for C++)const std::optional<org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter> &categoryOneOf
but using #isModel alone without #isOptional in mustache might produceconst org::openapitools::server::model::std::optional<org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter> &categoryOneOfinstead, that do not compile.
-
setIsOptional
void setIsOptional(boolean isOptional)
-
getIsArray
boolean getIsArray()
-
setIsArray
void setIsArray(boolean isArray)
-
getIsShort
boolean getIsShort()
-
setIsShort
void setIsShort(boolean isShort)
-
getIsBoolean
boolean getIsBoolean()
-
setIsBoolean
void setIsBoolean(boolean isBoolean)
-
getIsUnboundedInteger
boolean getIsUnboundedInteger()
-
setIsUnboundedInteger
void setIsUnboundedInteger(boolean isUnboundedInteger)
-
getIsPrimitiveType
boolean getIsPrimitiveType()
-
setIsPrimitiveType
void setIsPrimitiveType(boolean isPrimitiveType)
-
getAdditionalProperties
CodegenProperty getAdditionalProperties()
-
setAdditionalProperties
void setAdditionalProperties(CodegenProperty additionalProperties)
-
getVars
List<CodegenProperty> getVars()
-
setVars
void setVars(List<CodegenProperty> vars)
-
getRequiredVars
List<CodegenProperty> getRequiredVars()
-
setRequiredVars
void setRequiredVars(List<CodegenProperty> requiredVars)
-
getRequiredVarsMap
Map<String,CodegenProperty> getRequiredVarsMap()
-
setRequiredVarsMap
void setRequiredVarsMap(Map<String,CodegenProperty> requiredVarsMap)
-
getIsNull
boolean getIsNull()
-
setIsNull
void setIsNull(boolean isNull)
-
getIsVoid
boolean getIsVoid()
-
setIsVoid
void setIsVoid(boolean isVoid)
-
getHasValidation
boolean getHasValidation()
-
setHasValidation
void setHasValidation(boolean hasValidation)
-
getAdditionalPropertiesIsAnyType
boolean getAdditionalPropertiesIsAnyType()
-
setAdditionalPropertiesIsAnyType
void setAdditionalPropertiesIsAnyType(boolean additionalPropertiesIsAnyType)
-
getHasVars
boolean getHasVars()
-
setHasVars
void setHasVars(boolean hasVars)
-
getHasRequired
boolean getHasRequired()
-
setHasRequired
void setHasRequired(boolean hasRequired)
-
getHasDiscriminatorWithNonEmptyMapping
boolean getHasDiscriminatorWithNonEmptyMapping()
-
setHasDiscriminatorWithNonEmptyMapping
void setHasDiscriminatorWithNonEmptyMapping(boolean hasDiscriminatorWithNonEmptyMapping)
-
getIsString
boolean getIsString()
-
setIsString
void setIsString(boolean isString)
-
getIsNumber
boolean getIsNumber()
-
setIsNumber
void setIsNumber(boolean isNumber)
-
getIsAnyType
boolean getIsAnyType()
-
setIsAnyType
void setIsAnyType(boolean isAnyType)
-
getIsFreeFormObject
boolean getIsFreeFormObject()
-
setIsFreeFormObject
void setIsFreeFormObject(boolean isFreeFormObject)
-
getRef
String getRef()
-
setRef
void setRef(String ref)
-
getComposedSchemas
CodegenComposedSchemas getComposedSchemas()
-
setComposedSchemas
void setComposedSchemas(CodegenComposedSchemas composedSchemas)
-
getHasMultipleTypes
boolean getHasMultipleTypes()
-
setHasMultipleTypes
void setHasMultipleTypes(boolean hasMultipleTypes)
-
getIsBooleanSchemaTrue
boolean getIsBooleanSchemaTrue()
-
setIsBooleanSchemaTrue
void setIsBooleanSchemaTrue(boolean isBooleanSchemaTrue)
-
getIsBooleanSchemaFalse
boolean getIsBooleanSchemaFalse()
-
setIsBooleanSchemaFalse
void setIsBooleanSchemaFalse(boolean isBooleanSchemaFalse)
-
getSchemaIsFromAdditionalProperties
boolean getSchemaIsFromAdditionalProperties()
-
setSchemaIsFromAdditionalProperties
void setSchemaIsFromAdditionalProperties(boolean schemaIsFromAdditionalProperties)
-
setFormat
void setFormat(String format)
-
getFormat
String getFormat()
-
setDataType
void setDataType(String dataType)
-
getDataType
String getDataType()
-
setIsFloat
void setIsFloat(boolean isFloat)
-
getIsFloat
boolean getIsFloat()
-
setIsDouble
void setIsDouble(boolean isDouble)
-
getIsDouble
boolean getIsDouble()
-
setIsInteger
void setIsInteger(boolean isInteger)
-
getIsInteger
boolean getIsInteger()
-
setIsLong
void setIsLong(boolean isLong)
-
getIsLong
boolean getIsLong()
-
setIsBinary
void setIsBinary(boolean isBinary)
-
getIsBinary
boolean getIsBinary()
-
setIsByteArray
void setIsByteArray(boolean isByteArray)
-
getIsByteArray
boolean getIsByteArray()
-
setIsDecimal
void setIsDecimal(boolean isDecimal)
-
getIsDecimal
boolean getIsDecimal()
-
setIsUuid
void setIsUuid(boolean isUuid)
-
getIsUuid
boolean getIsUuid()
-
setIsEnum
void setIsEnum(boolean isEnum)
-
getIsEnum
boolean getIsEnum()
-
setTypeProperties
default void setTypeProperties(io.swagger.v3.oas.models.media.Schema p)
Syncs all the schema's type properties into the IJsonSchemaValidationProperties instance for now this only supports types without format information TODO: in the future move the format handling in here too- Parameters:
p- the schema which contains the type info
-
getBaseType
default String getBaseType()
- Returns:
- basic type - no generics supported.
-
getComplexType
default String getComplexType()
- Returns:
- complex type that can contain type parameters - like
List<Items>for Java
-
getImports
default Set<String> getImports(boolean importContainerType, boolean importBaseType, FeatureSet featureSet)
Recursively collect all necessary imports to include so that the type may be resolved.- Parameters:
importContainerType- whether or not to include the container types in the returned imports.importBaseType- whether or not to include the base types in the returned imports.featureSet- the generator feature set, used to determine if composed schemas should be added- Returns:
- all of the imports
-
-