CodegenProperty (openapi-generator (core library) 4.2.3 API)

java.lang.Object
- org.openapitools.codegen.CodegenProperty

All Implemented Interfaces:: Cloneable, IJsonSchemaValidationProperties

public class CodegenProperty
extends Object
implements Cloneable, IJsonSchemaValidationProperties

Field Summary

Fields
Modifier and Type	Field and Description
`List<String>`	`_enum`
`Map<String,Object>`	`allowableValues`
`String`	`baseName`
`String`	`baseType`
`String`	`complexType`
`String`	`containerType`
`String`	`dataFormat`
`String`	`dataType`
`String`	`datatypeWithEnum`
`String`	`defaultValue`
`String`	`defaultValueWithParam`
`boolean`	`deprecated`
`String`	`description`
`String`	`discriminatorValue`
`String`	`enumName`
`String`	`example` A free-form property to include an example of an instance for this schema.
`boolean`	`exclusiveMaximum`
`boolean`	`exclusiveMinimum`
`String`	`getter`
`boolean`	`hasMore`
`boolean`	`hasMoreNonReadOnly`
`boolean`	`hasValidation`
`boolean`	`isBinary`
`boolean`	`isBoolean`
`boolean`	`isByteArray`
`boolean`	`isCircularReference`
`boolean`	`isContainer`
`boolean`	`isDate`
`boolean`	`isDateTime`
`boolean`	`isDouble`
`boolean`	`isEmail`
`boolean`	`isEnum`
`boolean`	`isFile`
`boolean`	`isFloat`
`boolean`	`isFreeFormObject`
`boolean`	`isInherited`
`boolean`	`isInteger`
`boolean`	`isListContainer`
`boolean`	`isLong`
`boolean`	`isMapContainer`
`boolean`	`isModel`
`boolean`	`isNullable`
`boolean`	`isNumber`
`boolean`	`isNumeric`
`boolean`	`isPrimitiveType`
`boolean`	`isReadOnly`
`boolean`	`isSelfReference`
`boolean`	`isString`
`boolean`	`isUri`
`boolean`	`isUuid`
`boolean`	`isWriteOnly`
`boolean`	`isXmlAttribute`
`boolean`	`isXmlWrapped`
`CodegenProperty`	`items`
`String`	`jsonSchema`
`String`	`max`
`String`	`maximum`
`Integer`	`maxItems`
`Integer`	`maxLength` maxLength validation for strings, see http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.2.1
`String`	`min`
`String`	`minimum`
`Integer`	`minItems`
`Integer`	`minLength` minLength validation for strings, see http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.2.2
`CodegenProperty`	`mostInnerItems`
`Number`	`multipleOf`
`String`	`name`
`String`	`nameInCamelCase`
`String`	`nameInSnakeCase`
`String`	`openApiType`
`String`	`pattern` pattern validation for strings, see http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.2.3
`boolean`	`required`
`boolean`	`secondaryParam`
`String`	`setter`
`String`	`title`
`String`	`unescapedDescription` The 'description' string without escape charcters needed by some programming languages/targets
`Map<String,Object>`	`vendorExtensions`
`String`	`xmlName`
`String`	`xmlNamespace`
`String`	`xmlPrefix`

Constructor Summary

Constructors
Constructor and Description

CodegenProperty()

Constructors
Constructor and Description
`CodegenProperty()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CodegenProperty`	`clone()`
`boolean`	`equals(Object o)`
`List<String>`	`get_enum()`
`Map<String,Object>`	`getAllowableValues()`
`String`	`getBaseName()`
`String`	`getBaseType()`
`String`	`getComplexType()`
`String`	`getContainerType()`
`String`	`getDataFormat()`
`String`	`getDatatype()` Deprecated. since version 3.0.0, use `getDataType()` instead. May be removed with the next major release (4.0)
`String`	`getDataType()`
`String`	`getDatatypeWithEnum()`
`String`	`getDefaultValue()`
`String`	`getDefaultValueWithParam()`
`String`	`getDescription()`
`String`	`getEnumName()`
`String`	`getExample()`
`boolean`	`getExclusiveMaximum()`
`boolean`	`getExclusiveMinimum()`
`String`	`getGetter()`
`boolean`	`getIExclusiveMaximum()`
`CodegenProperty`	`getItems()`
`String`	`getJsonSchema()`
`String`	`getMax()`
`String`	`getMaximum()`
`Integer`	`getMaxItems()`
`Integer`	`getMaxLength()`
`Integer`	`getMaxProperties()`
`String`	`getMin()`
`String`	`getMinimum()`
`Integer`	`getMinItems()`
`Integer`	`getMinLength()`
`Integer`	`getMinProperties()`
`Number`	`getMultipleOf()`
`String`	`getName()`
`String`	`getNameInCamelCase()`
`String`	`getNameInSnakeCase()`
`String`	`getPattern()`
`boolean`	`getRequired()`
`boolean`	`getSecondaryParam()`
`String`	`getSetter()`
`String`	`getTitle()`
`String`	`getUnescapedDescription()`
`boolean`	`getUniqueItems()`
`Map<String,Object>`	`getVendorExtensions()`
`String`	`getXmlName()`
`String`	`getXmlNamespace()`
`String`	`getXmlPrefix()`
`int`	`hashCode()`
`void`	`set_enum(List<String> _enum)`
`void`	`setAllowableValues(Map<String,Object> allowableValues)`
`void`	`setBaseName(String baseName)`
`void`	`setBaseType(String baseType)`
`void`	`setComplexType(String complexType)`
`void`	`setContainerType(String containerType)`
`void`	`setDataFormat(String dataFormat)`
`void`	`setDatatype(String datatype)`
`void`	`setDatatypeWithEnum(String datatypeWithEnum)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setDefaultValueWithParam(String defaultValueWithParam)`
`void`	`setDescription(String description)`
`void`	`setEnumName(String enumName)`
`void`	`setExample(String example)`
`void`	`setExclusiveMaximum(boolean exclusiveMaximum)`
`void`	`setExclusiveMinimum(boolean exclusiveMinimum)`
`void`	`setGetter(String getter)`
`void`	`setItems(CodegenProperty items)`
`void`	`setJsonSchema(String jsonSchema)`
`void`	`setMax(String max)`
`void`	`setMaximum(String maximum)`
`void`	`setMaxItems(Integer maxItems)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMaxProperties(Integer maxProperties)`
`void`	`setMin(String min)`
`void`	`setMinimum(String minimum)`
`void`	`setMinItems(Integer minItems)`
`void`	`setMinLength(Integer minLength)`
`void`	`setMinProperties(Integer minProperties)`
`void`	`setMultipleOf(Number multipleOf)`
`void`	`setName(String name)`
`void`	`setNameInCamelCase(String nameInCamelCase)`
`void`	`setPattern(String pattern)`
`void`	`setRequired(boolean required)`
`void`	`setSecondaryParam(boolean secondaryParam)`
`void`	`setSetter(String setter)`
`void`	`setTitle(String title)`
`void`	`setUnescapedDescription(String unescapedDescription)`
`void`	`setUniqueItems(boolean uniqueItems)`
`void`	`setVendorExtensions(Map<String,Object> vendorExtensions)`
`void`	`setXmlName(String xmlName)`
`void`	`setXmlNamespace(String xmlNamespace)`
`void`	`setXmlPrefix(String xmlPrefix)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

openApiType
```
public String openApiType
```

baseName
```
public String baseName
```

complexType
```
public String complexType
```

getter
```
public String getter
```

setter
```
public String setter
```

description
```
public String description
```

dataType
```
public String dataType
```

datatypeWithEnum
```
public String datatypeWithEnum
```

dataFormat
```
public String dataFormat
```

name
```
public String name
```

min
```
public String min
```

max
```
public String max
```

defaultValue
```
public String defaultValue
```

defaultValueWithParam
```
public String defaultValueWithParam
```

baseType
```
public String baseType
```

containerType
```
public String containerType
```

title
```
public String title
```

unescapedDescription
```
public String unescapedDescription
```
The 'description' string without escape charcters needed by some programming languages/targets

maxLength
```
public Integer maxLength
```
maxLength validation for strings, see http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.2.1

minLength
```
public Integer minLength
```
minLength validation for strings, see http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.2.2

pattern
```
public String pattern
```
pattern validation for strings, see http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.2.3

example
```
public String example
```
A free-form property to include an example of an instance for this schema.

jsonSchema
```
public String jsonSchema
```

minimum
```
public String minimum
```

maximum
```
public String maximum
```

multipleOf
```
public Number multipleOf
```

exclusiveMinimum
```
public boolean exclusiveMinimum
```

exclusiveMaximum
```
public boolean exclusiveMaximum
```

hasMore
```
public boolean hasMore
```

required
```
public boolean required
```

deprecated
```
public boolean deprecated
```

secondaryParam
```
public boolean secondaryParam
```

hasMoreNonReadOnly
```
public boolean hasMoreNonReadOnly
```

isPrimitiveType
```
public boolean isPrimitiveType
```

isModel
```
public boolean isModel
```

isContainer
```
public boolean isContainer
```

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
```

isByteArray
```
public boolean isByteArray
```

isBinary
```
public boolean isBinary
```

isFile
```
public boolean isFile
```

isBoolean
```
public boolean isBoolean
```

isDate
```
public boolean isDate
```

isDateTime
```
public boolean isDateTime
```

isUuid
```
public boolean isUuid
```

isUri
```
public boolean isUri
```

isEmail
```
public boolean isEmail
```

isFreeFormObject
```
public boolean isFreeFormObject
```

isListContainer
```
public boolean isListContainer
```

isMapContainer
```
public boolean isMapContainer
```

isEnum
```
public boolean isEnum
```

isReadOnly
```
public boolean isReadOnly
```

isWriteOnly
```
public boolean isWriteOnly
```

isNullable
```
public boolean isNullable
```

isSelfReference
```
public boolean isSelfReference
```

isCircularReference
```
public boolean isCircularReference
```

_enum
```
public List<String> _enum
```

allowableValues

public Map<String,Object> allowableValues

items
```
public CodegenProperty items
```

mostInnerItems
```
public CodegenProperty mostInnerItems
```

vendorExtensions

public Map<String,Object> vendorExtensions

hasValidation
```
public boolean hasValidation
```

isInherited
```
public boolean isInherited
```

discriminatorValue
```
public String discriminatorValue
```

nameInCamelCase
```
public String nameInCamelCase
```

nameInSnakeCase
```
public String nameInSnakeCase
```

enumName
```
public String enumName
```

maxItems
```
public Integer maxItems
```

minItems
```
public Integer minItems
```

isXmlAttribute
```
public boolean isXmlAttribute
```

xmlPrefix
```
public String xmlPrefix
```

xmlName
```
public String xmlName
```

xmlNamespace
```
public String xmlNamespace
```

isXmlWrapped
```
public boolean isXmlWrapped
```

Constructor Detail
- CodegenProperty
```
public CodegenProperty()
```

Method Detail

getBaseName
```
public String getBaseName()
```

setBaseName

public void setBaseName(String baseName)

getComplexType
```
public String getComplexType()
```

setComplexType

public void setComplexType(String complexType)

getGetter
```
public String getGetter()
```

setGetter
```
public void setGetter(String getter)
```

getSetter
```
public String getSetter()
```

setSetter
```
public void setSetter(String setter)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getDatatype
```
@Deprecated
public String getDatatype()
```
Deprecated. since version 3.0.0, use getDataType() instead.
May be removed with the next major release (4.0)

Returns:

dataType

getDataType
```
public String getDataType()
```

setDatatype

public void setDatatype(String datatype)

getDatatypeWithEnum
```
public String getDatatypeWithEnum()
```

setDatatypeWithEnum

public void setDatatypeWithEnum(String datatypeWithEnum)

getDataFormat
```
public String getDataFormat()
```

setDataFormat

public void setDataFormat(String dataFormat)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getMin
```
public String getMin()
```

setMin
```
public void setMin(String min)
```

getMax
```
public String getMax()
```

setMax
```
public void setMax(String max)
```

getDefaultValue
```
public String getDefaultValue()
```

setDefaultValue

public void setDefaultValue(String defaultValue)

getDefaultValueWithParam

public String getDefaultValueWithParam()

setDefaultValueWithParam

public void setDefaultValueWithParam(String defaultValueWithParam)

getBaseType
```
public String getBaseType()
```

setBaseType

public void setBaseType(String baseType)

getContainerType
```
public String getContainerType()
```

setContainerType

public void setContainerType(String containerType)

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getUnescapedDescription

public String getUnescapedDescription()

setUnescapedDescription

public void setUnescapedDescription(String unescapedDescription)

getMaxLength
```
public Integer getMaxLength()
```
Specified by:

getMaxLength in interface IJsonSchemaValidationProperties

setMaxLength
```
public void setMaxLength(Integer maxLength)
```
Specified by:

setMaxLength in interface IJsonSchemaValidationProperties

getMinLength
```
public Integer getMinLength()
```
Specified by:

getMinLength in interface IJsonSchemaValidationProperties

setMinLength
```
public void setMinLength(Integer minLength)
```
Specified by:

setMinLength in interface IJsonSchemaValidationProperties

getPattern
```
public String getPattern()
```
Specified by:

getPattern in interface IJsonSchemaValidationProperties

setPattern
```
public void setPattern(String pattern)
```
Specified by:

setPattern in interface IJsonSchemaValidationProperties

getExample
```
public String getExample()
```

setExample

public void setExample(String example)

getJsonSchema
```
public String getJsonSchema()
```

setJsonSchema

public void setJsonSchema(String jsonSchema)

getMinimum
```
public String getMinimum()
```
Specified by:

getMinimum in interface IJsonSchemaValidationProperties

setMinimum
```
public void setMinimum(String minimum)
```
Specified by:

setMinimum in interface IJsonSchemaValidationProperties

getExclusiveMaximum
```
public boolean getExclusiveMaximum()
```
Specified by:

getExclusiveMaximum in interface IJsonSchemaValidationProperties

getMaximum
```
public String getMaximum()
```
Specified by:

getMaximum in interface IJsonSchemaValidationProperties

setMaximum
```
public void setMaximum(String maximum)
```
Specified by:

setMaximum in interface IJsonSchemaValidationProperties

getExclusiveMinimum
```
public boolean getExclusiveMinimum()
```
Specified by:

getExclusiveMinimum in interface IJsonSchemaValidationProperties

setExclusiveMinimum
```
public void setExclusiveMinimum(boolean exclusiveMinimum)
```
Specified by:

setExclusiveMinimum in interface IJsonSchemaValidationProperties

getIExclusiveMaximum
```
public boolean getIExclusiveMaximum()
```

setExclusiveMaximum
```
public void setExclusiveMaximum(boolean exclusiveMaximum)
```
Specified by:

setExclusiveMaximum in interface IJsonSchemaValidationProperties

getRequired
```
public boolean getRequired()
```

setRequired

public void setRequired(boolean required)

getSecondaryParam
```
public boolean getSecondaryParam()
```

setSecondaryParam

public void setSecondaryParam(boolean secondaryParam)

get_enum
```
public List<String> get_enum()
```

set_enum

public void set_enum(List<String> _enum)

getAllowableValues

public Map<String,Object> getAllowableValues()

setAllowableValues

public void setAllowableValues(Map<String,Object> allowableValues)

getItems
```
public CodegenProperty getItems()
```

setItems

public void setItems(CodegenProperty items)

getVendorExtensions

public Map<String,Object> getVendorExtensions()

setVendorExtensions

public void setVendorExtensions(Map<String,Object> vendorExtensions)

getNameInCamelCase
```
public String getNameInCamelCase()
```

setNameInCamelCase

public void setNameInCamelCase(String nameInCamelCase)

getNameInSnakeCase
```
public String getNameInSnakeCase()
```

getEnumName
```
public String getEnumName()
```

setEnumName

public void setEnumName(String enumName)

getMaxItems
```
public Integer getMaxItems()
```
Specified by:

getMaxItems in interface IJsonSchemaValidationProperties

setMaxItems
```
public void setMaxItems(Integer maxItems)
```
Specified by:

setMaxItems in interface IJsonSchemaValidationProperties

getMinItems
```
public Integer getMinItems()
```
Specified by:

getMinItems in interface IJsonSchemaValidationProperties

setMinItems
```
public void setMinItems(Integer minItems)
```
Specified by:

setMinItems in interface IJsonSchemaValidationProperties

getXmlPrefix
```
public String getXmlPrefix()
```

setXmlPrefix

public void setXmlPrefix(String xmlPrefix)

getXmlName
```
public String getXmlName()
```

setXmlName

public void setXmlName(String xmlName)

getXmlNamespace
```
public String getXmlNamespace()
```

setXmlNamespace

public void setXmlNamespace(String xmlNamespace)

clone
```
public CodegenProperty clone()
```
Overrides:

clone in class Object

getUniqueItems
```
public boolean getUniqueItems()
```
Specified by:

getUniqueItems in interface IJsonSchemaValidationProperties

setUniqueItems
```
public void setUniqueItems(boolean uniqueItems)
```
Specified by:

setUniqueItems in interface IJsonSchemaValidationProperties

getMinProperties
```
public Integer getMinProperties()
```
Specified by:

getMinProperties in interface IJsonSchemaValidationProperties

setMinProperties
```
public void setMinProperties(Integer minProperties)
```
Specified by:

setMinProperties in interface IJsonSchemaValidationProperties

getMaxProperties
```
public Integer getMaxProperties()
```
Specified by:

getMaxProperties in interface IJsonSchemaValidationProperties

setMaxProperties
```
public void setMaxProperties(Integer maxProperties)
```
Specified by:

setMaxProperties in interface IJsonSchemaValidationProperties

getMultipleOf
```
public Number getMultipleOf()
```
Specified by:

getMultipleOf in interface IJsonSchemaValidationProperties

setMultipleOf
```
public void setMultipleOf(Number multipleOf)
```
Specified by:

setMultipleOf in interface IJsonSchemaValidationProperties

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class CodegenProperty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

openApiType

baseName

complexType

getter

setter

description

dataType

datatypeWithEnum

dataFormat

name

min

max

defaultValue

defaultValueWithParam

baseType

containerType

title

unescapedDescription

maxLength

minLength

pattern

example

jsonSchema

minimum

maximum

multipleOf

exclusiveMinimum

exclusiveMaximum

hasMore

required

deprecated

secondaryParam

hasMoreNonReadOnly

isPrimitiveType

isModel

isContainer

isString

isNumeric

isInteger

isLong

isNumber

isFloat

isDouble

isByteArray

isBinary

isFile

isBoolean

isDate

isDateTime

isUuid

isUri

isEmail

isFreeFormObject

isListContainer

isMapContainer

isEnum

isReadOnly

isWriteOnly

isNullable

isSelfReference

isCircularReference

_enum

allowableValues

items

mostInnerItems

vendorExtensions

hasValidation

isInherited

discriminatorValue

nameInCamelCase

nameInSnakeCase

enumName

maxItems

minItems