Package org.openapitools.codegen.languages

Class AbstractJuliaCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractJuliaCodegen

All Implemented Interfaces:

CodegenConfig

Direct Known Subclasses:

JuliaClientCodegen, JuliaServerCodegen

public abstract class AbstractJuliaCodegen
extends DefaultCodegen

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiDocPath
protected String	apiSrcPath
protected SimpleDateFormat	DATE_FORMAT
protected SimpleDateFormat	DATE_TIME_FORMAT
protected Boolean	exportModels
protected Boolean	exportOperations
protected org.slf4j.Logger	LOGGER
protected String	modelDocPath
protected String	modelSrcPath
protected DateTimeFormatter	OFFSET_DATE_TIME_FORMAT
protected String	packageName
protected String	srcPath

Fields inherited from class org.openapitools.codegen.DefaultCodegen

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

Constructor Summary

Constructors

Constructor	Description
AbstractJuliaCodegen()

Method Summary

Modifier and Type	Method	Description
protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda>	addMustacheLambdas()	Preset map builder with commonly used Mustache lambdas.
String	apiDocFileFolder()
String	apiFileFolder()	Location to write api files.
protected static String	dropDots(String str)
String	escapeQuotationMark(String input)	Escape single and/or double quote to avoid code injection
protected String	escapeRegex(String pattern)
String	escapeReservedWord(String name)	Escapes a reserved word as defined in the `reservedWords` array.
String	escapeUnsafeCharacters(String input)	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers)	Convert OAS Operation object to Codegen Operation object
CodegenParameter	fromParameter(io.swagger.v3.oas.models.parameters.Parameter param, Set<String> imports)	Convert OpenAPI Parameter object to Codegen Parameter object
CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema schema, boolean required)	Convert OAS Property schema to Codegen Property object.
GeneratorLanguage	generatorLanguage()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema schema)	Return the type declaration for a given schema
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)	Output the language-specific type declaration of the property.
String	modelDocFileFolder()
String	modelFileFolder()	Location to write model files.
protected boolean	needsVarEscape(String name)
String	sanitizeName(String name)	Sanitize name (parameter, property, method, etc)
void	setExportModels(Boolean exportModels)
void	setExportOperations(Boolean exportOperations)
void	setPackageName(String packageName)
String	toApiFilename(String name)	Return the file name of the Api Test
String	toApiName(String name)	Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
String	toApiVarName(String name)	Return the variable name in the Api
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)	Return the default value of the property
String	toModelDocFilename(String name)	Return the capitalized file name of the model documentation
String	toModelFilename(String name)	Return the capitalized file name of the model
String	toModelName(String name)	Output the proper Julia model name.
String	toOperationId(String operationId)	Return the operation ID (method name)
String	toParamName(String name)	Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
String	toVarName(String name)	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getName, getOneOfAnyOfDescendants, getOpenAPIGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTag, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, nameMapping, needToImport, openapiGeneratorIgnoreList, openapiNormalizer, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessEnumVars, postProcessFile, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, preprocessOpenAPI, processCompiler, processOpenAPI, processOpts, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setAutosetConstants, 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, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiImport, toApiTestFilename, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelImport, toModelImportMap, toModelTestFilename, toOneOfName, toRegularExpression, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, 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

Field Detail

LOGGER

protected final org.slf4j.Logger LOGGER

srcPath

protected String srcPath

apiSrcPath

protected String apiSrcPath

modelSrcPath

protected String modelSrcPath

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

packageName

protected String packageName

exportModels

protected Boolean exportModels

exportOperations

protected Boolean exportOperations

OFFSET_DATE_TIME_FORMAT

protected final DateTimeFormatter OFFSET_DATE_TIME_FORMAT

DATE_TIME_FORMAT

protected final SimpleDateFormat DATE_TIME_FORMAT

DATE_FORMAT

protected final SimpleDateFormat DATE_FORMAT

Constructor Detail

AbstractJuliaCodegen

public AbstractJuliaCodegen()

Method Detail

generatorLanguage

public GeneratorLanguage generatorLanguage()

Specified by:

generatorLanguage in interface CodegenConfig

Overrides:

generatorLanguage in class DefaultCodegen

setPackageName

public void setPackageName(String packageName)

setExportModels

public void setExportModels(Boolean exportModels)

setExportOperations

public void setExportOperations(Boolean exportOperations)

dropDots

protected static String dropDots(String str)

escapeReservedWord

public String escapeReservedWord(String name)

Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reseved words

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped term

modelFileFolder

public String modelFileFolder()

Location to write model files.

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

apiFileFolder

public String apiFileFolder()

Location to write api files.

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegen

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegen

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Test

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegen

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

Specified by:

toParamName in interface CodegenConfig

Overrides:

toParamName in class DefaultCodegen

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toApiVarName

public String toApiVarName(String name)

Description copied from class: DefaultCodegen

Return the variable name in the Api

Specified by:

toApiVarName in interface CodegenConfig

Overrides:

toApiVarName in class DefaultCodegen

Parameters:

name - the variable name of the Api

Returns:

the snake-cased variable name

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegen

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Overrides:

toVarName in class DefaultCodegen

Parameters:

name - the variable name

Returns:

the sanitized variable name

sanitizeName

public String sanitizeName(String name)

Sanitize name (parameter, property, method, etc)

Specified by:

sanitizeName in interface CodegenConfig

Overrides:

sanitizeName in class DefaultCodegen

Parameters:

name - string to be sanitize

Returns:

sanitized string

needsVarEscape

protected boolean needsVarEscape(String name)

toModelName

public String toModelName(String name)

Output the proper Julia model name.

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

Parameters:

name - the name of the model

Returns:

Julia model name

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegen

Output the language-specific type declaration of the property.

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

schema - property schema

Returns:

a string presentation of the property type

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)

Return the type declaration for a given schema

Overrides:

getSchemaType in class DefaultCodegen

Parameters:

schema - the schema

Returns:

the type declaration

toDefaultValue

public String toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegen

Parameters:

schema - OpenAPI property object

Returns:

string presentation of the default value of the property

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegen

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

Specified by:

escapeUnsafeCharacters in interface CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

escapeQuotationMark

public String escapeQuotationMark(String input)

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegen

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeRegex

protected String escapeRegex(String pattern)

fromParameter

public CodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter param,
                                      Set<String> imports)

Convert OpenAPI Parameter object to Codegen Parameter object

Overrides:

fromParameter in class DefaultCodegen

Parameters:

imports - set of imports for library/package/module

param - OpenAPI parameter object

Returns:

Codegen Parameter object

fromProperty

public CodegenProperty fromProperty(String name,
                                    io.swagger.v3.oas.models.media.Schema schema,
                                    boolean required)

Convert OAS Property schema to Codegen Property object.

The return value is cached. An internal cache is looked up to determine if the CodegenProperty return value has already been instantiated for the (String name, Schema schema) arguments. Any subsequent processing of the CodegenModel return value must be idempotent for a given (String name, Schema schema).

Overrides:

fromProperty in class DefaultCodegen

Parameters:

name - name of the property

schema - OAS property schema

required - true if the property is required in the next higher object schema, false otherwise

Returns:

Codegen Property object

toOperationId

public String toOperationId(String operationId)

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegen

Parameters:

operationId - operation ID

Returns:

the sanitized method name

fromOperation

public CodegenOperation fromOperation(String path,
                                      String httpMethod,
                                      io.swagger.v3.oas.models.Operation operation,
                                      List<io.swagger.v3.oas.models.servers.Server> servers)

Convert OAS Operation object to Codegen Operation object

Specified by:

fromOperation in interface CodegenConfig

Overrides:

fromOperation in class DefaultCodegen

Parameters:

httpMethod - HTTP method

operation - OAS operation object

path - the path of the operation

servers - list of servers

Returns:

Codegen Operation object

addMustacheLambdas

protected com.google.common.collect.ImmutableMap.Builder<String,com.samskivert.mustache.Mustache.Lambda> addMustacheLambdas()

Description copied from class: DefaultCodegen

Preset map builder with commonly used Mustache lambdas. To extend the map, override addMustacheLambdas(), call parent method first and then add additional lambdas to the returned builder. If common lambdas are not desired, override addMustacheLambdas() method and return empty builder.

Overrides:

addMustacheLambdas in class DefaultCodegen

Returns:

preinitialized map with common lambdas