Package io.swagger.codegen.v3.generators.java

Class JavaClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

io.swagger.codegen.v3.generators.java.JavaClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig, BeanValidationFeatures, GzipFeatures, NotNullAnnotationFeatures, PerformBeanValidationFeatures

public class JavaClientCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures, PerformBeanValidationFeatures, GzipFeatures, NotNullAnnotationFeatures

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DO_NOT_USE_RX
protected boolean	doNotUseRx
protected String	gradleWrapperPackage
static final String	PARCELABLE_MODEL
protected boolean	parcelableModel
protected boolean	performBeanValidation
static final String	PLAY_24
static final String	PLAY_25
static final String	PLAY_VERSION
protected String	playVersion
static final String	RETROFIT_1
static final String	RETROFIT_2
static final String	USE_PLAY_WS
static final String	USE_RUNTIME_EXCEPTION
static final String	USE_RX_JAVA
static final String	USE_RX_JAVA2
static final String	USE_RX_JAVA3
protected boolean	useBeanValidation
protected boolean	useGzipFeature
protected boolean	usePlayWS
protected boolean	useRuntimeException
protected boolean	useRxJava
protected boolean	useRxJava2
protected boolean	useRxJava3

Fields inherited from class io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, CHECK_DUPLICATED_MODEL_NAME, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, developerEmail, developerName, developerOrganization, developerOrganizationUrl, ERROR_ON_UNKNOWN_ENUM, FULL_JAVA_UTIL, fullJavaUtil, groupId, invokerPackage, jakarta, JAKARTA, JAVA11_MODE, java11Mode, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, localVariablePrefix, modelDocPath, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_JAVA6, supportJava6, testFolder, USE_NULLABLE_FOR_NOTNULL, useNullableForNotNull, WIREMOCK_OPTION, WITH_XML, withXml

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Fields inherited from interface io.swagger.codegen.v3.generators.features.BeanValidationFeatures

USE_BEANVALIDATION

Fields inherited from interface io.swagger.codegen.v3.generators.features.GzipFeatures

USE_GZIP_FEATURE

Fields inherited from interface io.swagger.codegen.v3.generators.features.NotNullAnnotationFeatures

NOT_NULL_JACKSON_ANNOTATION

Fields inherited from interface io.swagger.codegen.v3.generators.features.PerformBeanValidationFeatures

PERFORM_BEANVALIDATION

Constructor Summary

Constructors

Constructor	Description
JavaClientCodegen()

Method Summary

Modifier and Type	Method	Description
String	apiFilename(String templateName, String tag)
String	getArgumentsLocation()
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
io.swagger.codegen.v3.CodegenType	getTag()
boolean	isNotNullJacksonAnnotation()
protected List<Map<String,Object>>	modelInheritanceSupportInGson(List<?> allModels)
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
Map<String,Object>	postProcessModelsEnum(Map<String,Object> objs)	post process enum defined in model's properties
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
void	processOpts()
void	setDoNotUseRx(boolean doNotUseRx)
void	setNotNullJacksonAnnotation(boolean notNullJacksonAnnotation)
void	setParcelableModel(boolean parcelableModel)
void	setPerformBeanValidation(boolean performBeanValidation)
void	setPlayVersion(String playVersion)
void	setUseBeanValidation(boolean useBeanValidation)
void	setUseGzipFeature(boolean useGzipFeature)
void	setUsePlayWS(boolean usePlayWS)
void	setUseRuntimeException(boolean useRuntimeException)
void	setUseRxJava(boolean useRxJava)
void	setUseRxJava2(boolean useRxJava2)
void	setUseRxJava3(boolean useRxJava3)

Methods inherited from class io.swagger.codegen.v3.generators.java.AbstractJavaCodegen

addAdditionPropertiesToCodeGenModel, addHandlebarHelpers, apiDocFileFolder, apiFileFolder, apiTestFileFolder, camelizeVarName, checkAliasModel, checkDuplicatedModelNameIgnoringCase, convertPropertyToBoolean, escapeQuotationMark, escapeReservedWord, escapeUnderscore, escapeUnsafeCharacters, fixUpParentAndInterfaces, fromModel, fromOperation, getAlias, getSchemaType, getTypeDeclaration, isSameEnum, modelDocFileFolder, modelFileFolder, needToImport, postProcessModels, postProcessParameter, preprocessOpenAPI, replaceDuplicatedInModelProperties, replaceDuplicatedInPaths, sanitizeTag, sanitizeVarName, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setFullJavaUtil, setGroupId, setInvokerPackage, setJakarta, setJava11Mode, setJava8Mode, setLanguageArguments, setLicenseName, setLicenseUrl, setLocalVariablePrefix, setParameterExampleValue, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportJava6, setTestFolder, setUseNullableForNotnull, setWithXml, toApiDocFilename, toApiFilename, toApiName, toApiTestFilename, toBooleanGetter, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toOperationId, toParamName, toRegularExpression, toVarName, writePropertyBack

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addCodegenContentParameters, addConsumesInfo, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, outputFolder, postProcessAllCodegenModels, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

getCodeName, getPriority, isPrivileged

Field Details

USE_RX_JAVA

public static final String USE_RX_JAVA

See Also:

• Constant Field Values

USE_RX_JAVA2

public static final String USE_RX_JAVA2

See Also:

• Constant Field Values

USE_RX_JAVA3

public static final String USE_RX_JAVA3

See Also:

• Constant Field Values

DO_NOT_USE_RX

public static final String DO_NOT_USE_RX

See Also:

• Constant Field Values

USE_PLAY_WS

public static final String USE_PLAY_WS

See Also:

• Constant Field Values

PLAY_VERSION

public static final String PLAY_VERSION

See Also:

• Constant Field Values

PARCELABLE_MODEL

public static final String PARCELABLE_MODEL

See Also:

• Constant Field Values

USE_RUNTIME_EXCEPTION

public static final String USE_RUNTIME_EXCEPTION

See Also:

• Constant Field Values

PLAY_24

public static final String PLAY_24

See Also:

• Constant Field Values

PLAY_25

public static final String PLAY_25

See Also:

• Constant Field Values

RETROFIT_1

public static final String RETROFIT_1

See Also:

• Constant Field Values

RETROFIT_2

public static final String RETROFIT_2

See Also:

• Constant Field Values

gradleWrapperPackage

protected String gradleWrapperPackage

useRxJava

protected boolean useRxJava

useRxJava2

protected boolean useRxJava2

useRxJava3

protected boolean useRxJava3

doNotUseRx

protected boolean doNotUseRx

usePlayWS

protected boolean usePlayWS

playVersion

protected String playVersion

parcelableModel

protected boolean parcelableModel

useBeanValidation

protected boolean useBeanValidation

performBeanValidation

protected boolean performBeanValidation

useGzipFeature

protected boolean useGzipFeature

useRuntimeException

protected boolean useRuntimeException

Constructor Details

JavaClientCodegen

public JavaClientCodegen()

Method Details

getTag

public io.swagger.codegen.v3.CodegenType getTag()

Specified by:

getTag in interface io.swagger.codegen.v3.CodegenConfig

getName

public String getName()

Specified by:

getName in interface io.swagger.codegen.v3.CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface io.swagger.codegen.v3.CodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class AbstractJavaCodegen

postProcessOperations

public Map<String,Object> postProcessOperations(Map<String,Object> objs)

Specified by:

postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessOperations in class AbstractJavaCodegen

apiFilename

public String apiFilename(String templateName,
 String tag)

Specified by:

apiFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiFilename in class DefaultCodegenConfig

postProcessModelProperty

public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
 io.swagger.codegen.v3.CodegenProperty property)

Specified by:

postProcessModelProperty in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModelProperty in class AbstractJavaCodegen

postProcessAllModels

public Map<String,Object> postProcessAllModels(Map<String,Object> objs)

Specified by:

postProcessAllModels in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegenConfig

postProcessModelsEnum

public Map<String,Object> postProcessModelsEnum(Map<String,Object> objs)

Description copied from class: DefaultCodegenConfig

post process enum defined in model's properties

Overrides:

postProcessModelsEnum in class DefaultCodegenConfig

Parameters:

objs - Map of models

Returns:

maps of models with better enum support

getArgumentsLocation

public String getArgumentsLocation()

Overrides:

getArgumentsLocation in class DefaultCodegenConfig

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

modelInheritanceSupportInGson

protected List<Map<String,Object>> modelInheritanceSupportInGson(List<?> allModels)

setUseRxJava

public void setUseRxJava(boolean useRxJava)

setUseRxJava2

public void setUseRxJava2(boolean useRxJava2)

setUseRxJava3

public void setUseRxJava3(boolean useRxJava3)

setDoNotUseRx

public void setDoNotUseRx(boolean doNotUseRx)

setUsePlayWS

public void setUsePlayWS(boolean usePlayWS)

setPlayVersion

public void setPlayVersion(String playVersion)

setParcelableModel

public void setParcelableModel(boolean parcelableModel)

setUseBeanValidation

public void setUseBeanValidation(boolean useBeanValidation)

Specified by:

setUseBeanValidation in interface BeanValidationFeatures

setPerformBeanValidation

public void setPerformBeanValidation(boolean performBeanValidation)

Specified by:

setPerformBeanValidation in interface PerformBeanValidationFeatures

setUseGzipFeature

public void setUseGzipFeature(boolean useGzipFeature)

Specified by:

setUseGzipFeature in interface GzipFeatures

setUseRuntimeException

public void setUseRuntimeException(boolean useRuntimeException)

setNotNullJacksonAnnotation

public void setNotNullJacksonAnnotation(boolean notNullJacksonAnnotation)

Specified by:

setNotNullJacksonAnnotation in interface NotNullAnnotationFeatures

isNotNullJacksonAnnotation

public boolean isNotNullJacksonAnnotation()

Specified by:

isNotNullJacksonAnnotation in interface NotNullAnnotationFeatures