Package org.openapitools.codegen.languages

Class KotlinClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractKotlinCodegen

org.openapitools.codegen.languages.KotlinClientCodegen

All Implemented Interfaces:

CodegenConfig

public class KotlinClientCodegen
extends AbstractKotlinCodegen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KotlinClientCodegen.CollectionType
static class	KotlinClientCodegen.DateLibrary
static class	KotlinClientCodegen.RequestDateConverter

Nested classes/interfaces inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen

AbstractKotlinCodegen.SERIALIZATION_LIBRARY_TYPE

Field Summary

Fields

Modifier and Type	Field	Description
protected String	authFolder
static String	COLLECTION_TYPE
protected String	collectionType
static String	DATE_LIBRARY
protected String	dateLibrary
static String	DO_NOT_USE_RX_AND_COROUTINES
protected boolean	doNotUseRxAndCoroutines
static String	GENERATE_ROOM_MODELS
protected boolean	generateRoomModels
static String	IDEA
protected static String	JVM
protected static String	JVM_KTOR
protected static String	JVM_OKHTTP
protected static String	JVM_OKHTTP3
protected static String	JVM_OKHTTP4
protected static String	JVM_RETROFIT2
protected static String	JVM_SPRING_WEBCLIENT
protected static String	JVM_VERTX
protected static String	JVM_VOLLEY
static String	MOSHI_CODE_GEN
protected static String	MULTIPLATFORM
static String	NULLABLE_RETURN_TYPE
static String	OMIT_GRADLE_PLUGIN_VERSIONS
static String	OMIT_GRADLE_WRAPPER
protected boolean	omitGradleWrapper
static String	REQUEST_DATE_CONVERTER
protected String	requestDateConverter
static String	ROOM_MODEL_PACKAGE
protected String	roomModelPackage
static String	SUPPORT_ANDROID_API_LEVEL_25_AND_BELLOW
static String	USE_COROUTINES
static String	USE_RX_JAVA3
static String	USE_SETTINGS_GRADLE
static String	USE_SPRING_BOOT3
protected boolean	useCoroutines
protected boolean	useRxJava
protected boolean	useRxJava2
protected boolean	useRxJava3
protected static String	VENDOR_EXTENSION_BASE_NAME_LITERAL

Fields inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen

ADDITIONAL_MODEL_TYPE_ANNOTATIONS, additionalModelTypeAnnotations, apiDocPath, apiSuffix, artifactId, artifactVersion, enumPropertyNaming, groupId, JAVAX_PACKAGE, MODEL_MUTABLE, MODEL_MUTABLE_DESC, modelDocPath, nonPublicApi, packageName, parcelizeModels, propertyAdditionalKeywords, resourcesFolder, serializableModel, SERIALIZATION_LIBRARY_DESC, serializationLibrary, sourceFolder, testFolder, USE_JAKARTA_EE, useJakartaEe

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, openapiNormalizer, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename

Constructor Summary

Constructors

Constructor	Description
KotlinClientCodegen()	Constructs an instance of `KotlinClientCodegen`.

Method Summary

Modifier and Type	Method	Description
boolean	getGenerateRoomModels()
String	getHelp()
String	getName()
boolean	getOmitGradleWrapper()
CodegenType	getTag()
String	modelFilename(String templateName, String modelName)
void	postProcess()
ModelsMap	postProcessModels(ModelsMap objs)
OperationsMap	postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
void	processOpts()
String	roomModelFileFolder()
void	setCollectionType(String collectionType)
void	setDateLibrary(String library)
void	setDoNotUseRxAndCoroutines(boolean doNotUseRxAndCoroutines)
void	setGenerateRoomModels(Boolean generateRoomModels)
void	setOmitGradleWrapper(boolean omitGradleWrapper)
void	setRequestDateConverter(String converter)
void	setRoomModelPackage(String roomModelPackage)
void	setUseCoroutines(boolean useCoroutines)
void	setUseRxJava3(boolean useRxJava3)

Methods inherited from class org.openapitools.codegen.languages.AbstractKotlinCodegen

apiDocFileFolder, apiFileFolder, apiTestFileFolder, applyJakartaPackage, applyJavaxPackage, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromModel, generatorLanguage, getAdditionalModelTypeAnnotations, getEnumPropertyNaming, getParcelizeModels, getSchemaType, getSerializationLibrary, getTypeDeclaration, isDataTypeString, isModelMutable, isReservedWord, isSerializableModel, modelDocFileFolder, modelFileFolder, needToImport, nonPublicApi, postProcessAllModels, postProcessFile, setAdditionalModelTypeAnnotations, setApiSuffix, setArtifactId, setArtifactVersion, setEnumPropertyNaming, setGroupId, setNonPublicApi, setPackageName, setParcelizeModels, setSerializableModel, setSerializationLibrary, setSourceFolder, setTestFolder, setUseJakartaEe, toApiName, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelFilename, toModelImport, toModelName, toOperationId, toParamName, toRegularExpression, toVariableName, toVarName, updateModelForObject

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalProperties, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, openapiNormalizer, outputFolder, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelImportMap, toModelTestFilename, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, openapiNormalizer, outputFolder, postProcessModelProperty, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImportMap, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

Field Detail

JVM

protected static final String JVM

See Also:

Constant Field Values

JVM_KTOR

protected static final String JVM_KTOR

See Also:

Constant Field Values

JVM_OKHTTP

protected static final String JVM_OKHTTP

See Also:

Constant Field Values

JVM_OKHTTP4

protected static final String JVM_OKHTTP4

See Also:

Constant Field Values

JVM_OKHTTP3

protected static final String JVM_OKHTTP3

See Also:

Constant Field Values

JVM_RETROFIT2

protected static final String JVM_RETROFIT2

See Also:

Constant Field Values

MULTIPLATFORM

protected static final String MULTIPLATFORM

See Also:

Constant Field Values

JVM_VOLLEY

protected static final String JVM_VOLLEY

See Also:

Constant Field Values

JVM_VERTX

protected static final String JVM_VERTX

See Also:

Constant Field Values

JVM_SPRING_WEBCLIENT

protected static final String JVM_SPRING_WEBCLIENT

See Also:

Constant Field Values

USE_RX_JAVA3

public static final String USE_RX_JAVA3

See Also:

Constant Field Values

USE_COROUTINES

public static final String USE_COROUTINES

See Also:

Constant Field Values

DO_NOT_USE_RX_AND_COROUTINES

public static final String DO_NOT_USE_RX_AND_COROUTINES

See Also:

Constant Field Values

GENERATE_ROOM_MODELS

public static final String GENERATE_ROOM_MODELS

See Also:

Constant Field Values

ROOM_MODEL_PACKAGE

public static final String ROOM_MODEL_PACKAGE

See Also:

Constant Field Values

OMIT_GRADLE_PLUGIN_VERSIONS

public static final String OMIT_GRADLE_PLUGIN_VERSIONS

See Also:

Constant Field Values

OMIT_GRADLE_WRAPPER

public static final String OMIT_GRADLE_WRAPPER

See Also:

Constant Field Values

USE_SETTINGS_GRADLE

public static final String USE_SETTINGS_GRADLE

See Also:

Constant Field Values

IDEA

public static final String IDEA

See Also:

Constant Field Values

USE_SPRING_BOOT3

public static final String USE_SPRING_BOOT3

See Also:

Constant Field Values

DATE_LIBRARY

public static final String DATE_LIBRARY

See Also:

Constant Field Values

REQUEST_DATE_CONVERTER

public static final String REQUEST_DATE_CONVERTER

See Also:

Constant Field Values

COLLECTION_TYPE

public static final String COLLECTION_TYPE

See Also:

Constant Field Values

MOSHI_CODE_GEN

public static final String MOSHI_CODE_GEN

See Also:

Constant Field Values

NULLABLE_RETURN_TYPE

public static final String NULLABLE_RETURN_TYPE

See Also:

Constant Field Values

SUPPORT_ANDROID_API_LEVEL_25_AND_BELLOW

public static final String SUPPORT_ANDROID_API_LEVEL_25_AND_BELLOW

See Also:

Constant Field Values

VENDOR_EXTENSION_BASE_NAME_LITERAL

protected static final String VENDOR_EXTENSION_BASE_NAME_LITERAL

See Also:

Constant Field Values

dateLibrary

protected String dateLibrary

requestDateConverter

protected String requestDateConverter

collectionType

protected String collectionType

useRxJava

protected boolean useRxJava

useRxJava2

protected boolean useRxJava2

useRxJava3

protected boolean useRxJava3

useCoroutines

protected boolean useCoroutines

doNotUseRxAndCoroutines

protected boolean doNotUseRxAndCoroutines

generateRoomModels

protected boolean generateRoomModels

roomModelPackage

protected String roomModelPackage

omitGradleWrapper

protected boolean omitGradleWrapper

authFolder

protected String authFolder

Constructor Detail

KotlinClientCodegen

public KotlinClientCodegen()

Constructs an instance of `KotlinClientCodegen`.

Method Detail

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

getGenerateRoomModels

public boolean getGenerateRoomModels()

getOmitGradleWrapper

public boolean getOmitGradleWrapper()

setGenerateRoomModels

public void setGenerateRoomModels(Boolean generateRoomModels)

setUseRxJava3

public void setUseRxJava3(boolean useRxJava3)

setDoNotUseRxAndCoroutines

public void setDoNotUseRxAndCoroutines(boolean doNotUseRxAndCoroutines)

setUseCoroutines

public void setUseCoroutines(boolean useCoroutines)

setDateLibrary

public void setDateLibrary(String library)

setRequestDateConverter

public void setRequestDateConverter(String converter)

setCollectionType

public void setCollectionType(String collectionType)

setRoomModelPackage

public void setRoomModelPackage(String roomModelPackage)

setOmitGradleWrapper

public void setOmitGradleWrapper(boolean omitGradleWrapper)

modelFilename

public String modelFilename(String templateName,
                            String modelName)

Specified by:

modelFilename in interface CodegenConfig

Overrides:

modelFilename in class DefaultCodegen

roomModelFileFolder

public String roomModelFileFolder()

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractKotlinCodegen

postProcessModels

public ModelsMap postProcessModels(ModelsMap objs)

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractKotlinCodegen

postProcessOperationsWithModels

public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

postProcess

public void postProcess()

Specified by:

postProcess in interface CodegenConfig

Overrides:

postProcess in class DefaultCodegen