Class JavaVertXServerCodegen
java.lang.Object
io.swagger.codegen.v3.generators.DefaultCodegenConfig
io.swagger.codegen.v3.generators.java.AbstractJavaCodegen
io.swagger.codegen.v3.generators.java.JavaVertXServerCodegen
- All Implemented Interfaces:
io.swagger.codegen.v3.CodegenConfig,BeanValidationFeatures,NotNullAnnotationFeatures
public class JavaVertXServerCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures, NotNullAnnotationFeatures
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected Stringstatic final Stringstatic final Stringstatic final Stringprotected booleanprotected booleanprotected booleanprotected Stringstatic final Stringstatic final Stringprotected Stringstatic final Stringstatic final Stringprotected booleanprotected booleanFields 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, withXmlFields 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, vendorExtensionsFields inherited from interface io.swagger.codegen.v3.generators.features.BeanValidationFeatures
USE_BEANVALIDATIONFields inherited from interface io.swagger.codegen.v3.generators.features.NotNullAnnotationFeatures
NOT_NULL_JACKSON_ANNOTATION -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionio.swagger.codegen.v3.CodegenModelfromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String, io.swagger.v3.oas.models.media.Schema> allSchemas) Convert Swagger Model object to Codegen Model objectgetHelp()Returns human-friendly help for the generator.getName()Configures a friendly name for the generator.io.swagger.codegen.v3.CodegenTypegetTag()Configures the type of generator.booleanvoidpostProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property) voidpreprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) voidvoidsetNotNullJacksonAnnotation(boolean notNullJacksonAnnotation) voidsetUseBeanValidation(boolean useBeanValidation) 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, fromOperation, getAlias, getSchemaType, getTypeDeclaration, isSameEnum, modelDocFileFolder, modelFileFolder, needToImport, postProcessModels, postProcessOperations, postProcessParameter, 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, writePropertyBackMethods 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, apiFilename, 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, getArgumentsLocation, 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, postProcessAllModels, postProcessModelsEnum, 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, writeOptionalMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.swagger.codegen.v3.CodegenConfig
getCodeName, getPriority, isPrivileged
-
Field Details
-
RX_INTERFACE_OPTION
- See Also:
-
USE_DATAOBJECT_OPTION
- See Also:
-
MOUNT_OPERATION_FROM_OPTION
- See Also:
-
MOUNT_OPERATION_FROM_EXTENSIONS
- See Also:
-
MOUNT_OPERATION_FROM_INTERFACE
- See Also:
-
SPEC_LOCATION_OPTION
- See Also:
-
USE_FUTURE_OPTION
- See Also:
-
rootPackage
-
apiVerticle
-
apiVersion
-
useDataObject
protected boolean useDataObject -
mountFromExtensions
protected boolean mountFromExtensions -
mountFromInterface
protected boolean mountFromInterface -
title
-
useBeanValidation
protected boolean useBeanValidation -
notNullJacksonAnnotation
protected boolean notNullJacksonAnnotation
-
-
Constructor Details
-
JavaVertXServerCodegen
public JavaVertXServerCodegen()A Java Vert.X generator. It can be configured with CLI options :- rxInterface : type Boolean if true, API interfaces are generated with RX and methods return Single and Comparable. default : false
- useDataObject : type Boolean if true, models objects are generated with @DataObject
- mountOperationFrom : type String, define how routes are mounted.
- specLocation : define spec location, default as
SPEC_LOCATION. - useFuture : define use services as future, default false.
-
-
Method Details
-
getTag
public io.swagger.codegen.v3.CodegenType getTag()Configures the type of generator.- Specified by:
getTagin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- the CodegenType for this generator
- See Also:
-
CodegenType
-
getName
Configures a friendly name for the generator. This will be used by the generator to select the library with the -l flag.- Specified by:
getNamein interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- the friendly name for the generator
-
getHelp
Returns human-friendly help for the generator. Provide the consumer with help tips, parameters here- Specified by:
getHelpin interfaceio.swagger.codegen.v3.CodegenConfig- Returns:
- A string value for the help message
-
getDefaultTemplateDir
- Specified by:
getDefaultTemplateDirin classDefaultCodegenConfig
-
processOpts
public void processOpts()- Specified by:
processOptsin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
processOptsin classAbstractJavaCodegen
-
postProcessModelProperty
public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property) - Specified by:
postProcessModelPropertyin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
postProcessModelPropertyin classAbstractJavaCodegen
-
fromModel
public io.swagger.codegen.v3.CodegenModel fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String, io.swagger.v3.oas.models.media.Schema> allSchemas) Description copied from class:DefaultCodegenConfigConvert Swagger Model object to Codegen Model object- Specified by:
fromModelin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
fromModelin classAbstractJavaCodegen- Parameters:
name- the name of the modelschema- Swagger Model objectallSchemas- a map of all Swagger models from the spec- Returns:
- Codegen Model object
-
preprocessOpenAPI
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) - Specified by:
preprocessOpenAPIin interfaceio.swagger.codegen.v3.CodegenConfig- Overrides:
preprocessOpenAPIin classAbstractJavaCodegen
-
setUseBeanValidation
public void setUseBeanValidation(boolean useBeanValidation) - Specified by:
setUseBeanValidationin interfaceBeanValidationFeatures
-
setNotNullJacksonAnnotation
public void setNotNullJacksonAnnotation(boolean notNullJacksonAnnotation) - Specified by:
setNotNullJacksonAnnotationin interfaceNotNullAnnotationFeatures
-
isNotNullJacksonAnnotation
public boolean isNotNullJacksonAnnotation()- Specified by:
isNotNullJacksonAnnotationin interfaceNotNullAnnotationFeatures
-