org.openapitools.codegen.languages

Class JavaClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractJavaCodegen

org.openapitools.codegen.languages.JavaClientCodegen

All Implemented Interfaces:

CodegenConfig, BeanValidationFeatures, GzipFeatures, PerformBeanValidationFeatures

public class JavaClientCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures, PerformBeanValidationFeatures, GzipFeatures

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authFolder
static String	CASE_INSENSITIVE_RESPONSE_HEADERS
protected boolean	caseInsensitiveResponseHeaders
static String	DO_NOT_USE_RX
protected boolean	doNotUseRx
static String	FEIGN
static String	FEIGN_10
static String	FEIGN_9
static String	FEIGN_VERSION
protected String	feignVersion
static String	GOOGLE_API_CLIENT
protected String	gradleWrapperPackage
static String	JERSEY1
static String	JERSEY2
static String	NATIVE
static String	OKHTTP_GSON
static String	PARCELABLE_MODEL
protected boolean	parcelableModel
protected boolean	performBeanValidation
static String	PLAY_24
static String	PLAY_25
static String	PLAY_26
static String	PLAY_VERSION
protected String	playVersion
static String	REST_ASSURED
static String	RESTEASY
static String	RESTTEMPLATE
static String	RETROFIT_1
static String	RETROFIT_2
static String	SERIALIZATION_LIBRARY_GSON
static String	SERIALIZATION_LIBRARY_JACKSON
protected String	serializationLibrary
static String	USE_PLAY_WS
static String	USE_REFLECTION_EQUALS_HASHCODE
static String	USE_RUNTIME_EXCEPTION
static String	USE_RX_JAVA
static String	USE_RX_JAVA2
protected boolean	useBeanValidation
protected boolean	useGzipFeature
protected boolean	usePlayWS
protected boolean	useReflectionEqualsHashCode
protected boolean	useRuntimeException
protected boolean	useRxJava
protected boolean	useRxJava2
static String	VERTX
static String	WEBCLIENT

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

apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, BOOLEAN_GETTER_PREFIX, booleanGetterPrefix, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, developerEmail, developerName, developerOrganization, developerOrganizationUrl, DISABLE_HTML_ESCAPING, disableHtmlEscaping, FULL_JAVA_UTIL, fullJavaUtil, groupId, invokerPackage, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, modelDocPath, parentArtifactId, parentGroupId, parentOverridden, parentVersion, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, SUPPORT_JAVA6, supportAsync, supportJava6, testFolder, WITH_XML, withXml

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Fields inherited from interface org.openapitools.codegen.languages.features.BeanValidationFeatures

USE_BEANVALIDATION

Fields inherited from interface org.openapitools.codegen.languages.features.PerformBeanValidationFeatures

PERFORM_BEANVALIDATION

Fields inherited from interface org.openapitools.codegen.languages.features.GzipFeatures

USE_GZIP_FEATURE

Constructor Summary

Constructors

Constructor and Description
JavaClientCodegen()

Method Summary

Modifier and Type	Method and Description
String	apiFilename(String templateName, String tag)
void	forceSerializationLibrary(String serializationLibrary)
String	getHelp()
String	getName()
String	getSerializationLibrary() Serialization library.
CodegenType	getTag()
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessModelsEnum(Map<String,Object> objs) post process enum defined in model's properties
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	processOpts()
void	setCaseInsensitiveResponseHeaders(Boolean caseInsensitiveResponseHeaders)
void	setDoNotUseRx(boolean doNotUseRx)
void	setFeignVersion(String feignVersion)
void	setParcelableModel(boolean parcelableModel)
void	setPerformBeanValidation(boolean performBeanValidation)
void	setPlayVersion(String playVersion)
void	setSerializationLibrary(String serializationLibrary)
void	setUseBeanValidation(boolean useBeanValidation)
void	setUseGzipFeature(boolean useGzipFeature)
void	setUsePlayWS(boolean usePlayWS)
void	setUseReflectionEqualsHashCode(boolean useReflectionEqualsHashCode)
void	setUseRuntimeException(boolean useRuntimeException)
void	setUseRxJava(boolean useRxJava)
void	setUseRxJava2(boolean useRxJava2)
String	toApiVarName(String name) Return the variable name in the Api

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

addAdditionPropertiesToCodeGenModel, apiDocFileFolder, apiFileFolder, apiTestFileFolder, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromModel, fromOperation, getAlias, getArtifactDescription, getArtifactId, getArtifactUrl, getArtifactVersion, getBooleanGetterPrefix, getDateLibrary, getDeveloperEmail, getDeveloperName, getDeveloperOrganization, getDeveloperOrganizationUrl, getGroupId, getInvokerPackage, getLicenseName, getLicenseUrl, getSchemaType, getScmConnection, getScmDeveloperConnection, getScmUrl, getSerializableModel, getSourceFolder, getterAndSetterCapitalize, getTestFolder, getTypeDeclaration, modelDocFileFolder, modelFileFolder, modelTestFileFolder, needToImport, postProcessFile, preprocessOpenAPI, sanitizeTag, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setBooleanGetterPrefix, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setFullJavaUtil, setGroupId, setInvokerPackage, setJava8Mode, setLicenseName, setLicenseUrl, setParameterExampleValue, setParentArtifactId, setParentGroupId, setParentOverridden, setParentVersion, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setSupportJava6, setTestFolder, setWithXml, toApiDocFilename, toApiFilename, toApiTestFilename, toBooleanGetter, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addImport, additionalProperties, addMustacheLambdas, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAllowUnicodeIdentifiers, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getEnsureUniqueParams, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaItems, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiImport, toApiName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toOneOfName, toSetter, typeMapping, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateOption, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, 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, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessParameter, postProcessSupportingFileData, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiName, toGetter, toModelImport, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

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

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

FEIGN_VERSION

public static final String FEIGN_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

USE_REFLECTION_EQUALS_HASHCODE

public static final String USE_REFLECTION_EQUALS_HASHCODE

See Also:

Constant Field Values

CASE_INSENSITIVE_RESPONSE_HEADERS

public static final String CASE_INSENSITIVE_RESPONSE_HEADERS

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

PLAY_26

public static final String PLAY_26

See Also:

Constant Field Values

FEIGN_9

public static final String FEIGN_9

See Also:

Constant Field Values

FEIGN_10

public static final String FEIGN_10

See Also:

Constant Field Values

FEIGN

public static final String FEIGN

See Also:

Constant Field Values

GOOGLE_API_CLIENT

public static final String GOOGLE_API_CLIENT

See Also:

Constant Field Values

JERSEY1

public static final String JERSEY1

See Also:

Constant Field Values

JERSEY2

public static final String JERSEY2

See Also:

Constant Field Values

NATIVE

public static final String NATIVE

See Also:

Constant Field Values

OKHTTP_GSON

public static final String OKHTTP_GSON

See Also:

Constant Field Values

RESTEASY

public static final String RESTEASY

See Also:

Constant Field Values

RESTTEMPLATE

public static final String RESTTEMPLATE

See Also:

Constant Field Values

WEBCLIENT

public static final String WEBCLIENT

See Also:

Constant Field Values

REST_ASSURED

public static final String REST_ASSURED

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

VERTX

public static final String VERTX

See Also:

Constant Field Values

SERIALIZATION_LIBRARY_GSON

public static final String SERIALIZATION_LIBRARY_GSON

See Also:

Constant Field Values

SERIALIZATION_LIBRARY_JACKSON

public static final String SERIALIZATION_LIBRARY_JACKSON

See Also:

Constant Field Values

gradleWrapperPackage

protected String gradleWrapperPackage

useRxJava

protected boolean useRxJava

useRxJava2

protected boolean useRxJava2

doNotUseRx

protected boolean doNotUseRx

usePlayWS

protected boolean usePlayWS

playVersion

protected String playVersion

feignVersion

protected String feignVersion

parcelableModel

protected boolean parcelableModel

useBeanValidation

protected boolean useBeanValidation

performBeanValidation

protected boolean performBeanValidation

useGzipFeature

protected boolean useGzipFeature

useRuntimeException

protected boolean useRuntimeException

useReflectionEqualsHashCode

protected boolean useReflectionEqualsHashCode

caseInsensitiveResponseHeaders

protected boolean caseInsensitiveResponseHeaders

authFolder

protected String authFolder

serializationLibrary

protected String serializationLibrary

Constructor Detail

JavaClientCodegen

public JavaClientCodegen()

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

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractJavaCodegen

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class AbstractJavaCodegen

apiFilename

public String apiFilename(String templateName,
                          String tag)

Specified by:

apiFilename in interface CodegenConfig

Overrides:

apiFilename in class DefaultCodegen

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

Specified by:

postProcessModelProperty in interface CodegenConfig

Overrides:

postProcessModelProperty in class AbstractJavaCodegen

postProcessModelsEnum

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

Description copied from class: DefaultCodegen

post process enum defined in model's properties

Overrides:

postProcessModelsEnum in class DefaultCodegen

Parameters:

objs - Map of models

Returns:

maps of models with better enum support

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractJavaCodegen

setUseRxJava

public void setUseRxJava(boolean useRxJava)

setUseRxJava2

public void setUseRxJava2(boolean useRxJava2)

setDoNotUseRx

public void setDoNotUseRx(boolean doNotUseRx)

setUsePlayWS

public void setUsePlayWS(boolean usePlayWS)

setPlayVersion

public void setPlayVersion(String playVersion)

setFeignVersion

public void setFeignVersion(String feignVersion)

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)

setUseReflectionEqualsHashCode

public void setUseReflectionEqualsHashCode(boolean useReflectionEqualsHashCode)

setCaseInsensitiveResponseHeaders

public void setCaseInsensitiveResponseHeaders(Boolean caseInsensitiveResponseHeaders)

getSerializationLibrary

public String getSerializationLibrary()

Serialization library.

Returns:

'gson' or 'jackson'

setSerializationLibrary

public void setSerializationLibrary(String serializationLibrary)

forceSerializationLibrary

public void forceSerializationLibrary(String serializationLibrary)

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 varible name of the Api

Returns:

the snake-cased variable name