org.openapitools.codegen.languages

类 JavaPlayFrameworkCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractJavaCodegen

org.openapitools.codegen.languages.JavaPlayFrameworkCodegen

所有已实现的接口:

CodegenConfig, BeanValidationFeatures

public class JavaPlayFrameworkCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures

字段概要

字段

限定符和类型	字段和说明
static String	BASE_PACKAGE
protected String	basePackage
static String	CONFIG_PACKAGE
protected String	configPackage
static String	CONTROLLER_ONLY
protected boolean	controllerOnly
static String	HANDLE_EXCEPTIONS
protected boolean	handleExceptions
protected String	title
static String	TITLE
static String	USE_INTERFACES
static String	USE_SWAGGER_UI
protected boolean	useBeanValidation
protected boolean	useInterfaces
protected boolean	useSwaggerUI
static String	WRAP_CALLS
protected boolean	wrapCalls

从类继承的字段 org.openapitools.codegen.languages.AbstractJavaCodegen

apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, BOOLEAN_GETTER_PREFIX, BOOLEAN_GETTER_PREFIX_DEFAULT, 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, localVariablePrefix, modelDocPath, parentArtifactId, parentGroupId, parentOverridden, parentVersion, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, SUPPORT_JAVA6, supportAsync, supportJava6, testFolder, USE_NULL_FOR_UNKNOWN_ENUM_VALUE, useNullForUnknownEnumValue, WITH_XML, withXml

从类继承的字段 org.openapitools.codegen.DefaultCodegen

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

从接口继承的字段 org.openapitools.codegen.languages.features.BeanValidationFeatures

USE_BEANVALIDATION

构造器概要

构造器

构造器和说明
JavaPlayFrameworkCodegen()

方法概要

限定符和类型	方法和说明
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema model, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions) Convert OAS Model object to Codegen Model object
String	getBasePackage()
String	getConfigPackage()
String	getHelp()
String	getName()
CodegenType	getTag()
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	processOpts()
void	setBasePackage(String basePackage)
void	setConfigPackage(String configPackage)
void	setControllerOnly(boolean controllerOnly)
void	setHandleExceptions(boolean handleExceptions)
void	setTitle(String title)
void	setUseBeanValidation(boolean useBeanValidation)
void	setUseInterfaces(boolean useInterfaces)
void	setUseSwaggerUI(boolean useSwaggerUI)
void	setWrapCalls(boolean wrapCalls)

从类继承的方法 org.openapitools.codegen.languages.AbstractJavaCodegen

apiDocFileFolder, apiFileFolder, apiTestFileFolder, convertPropertyToBoolean, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromOperation, getAccept, getAlias, getInvokerPackage, getSchemaType, getTypeDeclaration, modelDocFileFolder, modelFileFolder, needToImport, postProcessFile, postProcessModels, postProcessParameter, preprocessOpenAPI, sanitizeTag, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setBooleanGetterPrefix, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setFullJavaUtil, setGroupId, setInvokerPackage, setJava8Mode, setLicenseName, setLicenseUrl, setLocalVariablePrefix, setParameterExampleValue, setParentArtifactId, setParentGroupId, setParentOverridden, setParentVersion, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setSupportJava6, setTestFolder, setUseNullForUnknownEnumValue, setWithXml, toApiDocFilename, toApiFilename, toApiName, toApiTestFilename, toBooleanGetter, toDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExampleValue, toModelDocFilename, toModelFilename, toModelName, toOperationId, toParamName, toRegularExpression, toVarName, writePropertyBack

从类继承的方法 org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelsEnum, postProcessOperations, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessOperations, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

字段详细资料

TITLE

public static final String TITLE

另请参阅:

常量字段值

CONFIG_PACKAGE

public static final String CONFIG_PACKAGE

另请参阅:

常量字段值

BASE_PACKAGE

public static final String BASE_PACKAGE

另请参阅:

常量字段值

CONTROLLER_ONLY

public static final String CONTROLLER_ONLY

另请参阅:

常量字段值

USE_INTERFACES

public static final String USE_INTERFACES

另请参阅:

常量字段值

HANDLE_EXCEPTIONS

public static final String HANDLE_EXCEPTIONS

另请参阅:

常量字段值

WRAP_CALLS

public static final String WRAP_CALLS

另请参阅:

常量字段值

USE_SWAGGER_UI

public static final String USE_SWAGGER_UI

另请参阅:

常量字段值

title

protected String title

configPackage

protected String configPackage

basePackage

protected String basePackage

controllerOnly

protected boolean controllerOnly

useInterfaces

protected boolean useInterfaces

useBeanValidation

protected boolean useBeanValidation

handleExceptions

protected boolean handleExceptions

wrapCalls

protected boolean wrapCalls

useSwaggerUI

protected boolean useSwaggerUI

构造器详细资料

JavaPlayFrameworkCodegen

public JavaPlayFrameworkCodegen()

方法详细资料

getTag

public CodegenType getTag()

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

getName

public String getName()

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

getHelp

public String getHelp()

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 AbstractJavaCodegen

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

指定者:

postProcessModelProperty 在接口中 CodegenConfig

覆盖:

postProcessModelProperty 在类中 AbstractJavaCodegen

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema model,
                              Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)

从类复制的说明: DefaultCodegen

Convert OAS Model object to Codegen Model object

指定者:

fromModel 在接口中 CodegenConfig

覆盖:

fromModel 在类中 AbstractJavaCodegen

参数:

name - the name of the model

model - OAS Model object

allDefinitions - a map of all OAS models from the spec

返回:

Codegen Model object

setTitle

public void setTitle(String title)

getConfigPackage

public String getConfigPackage()

setConfigPackage

public void setConfigPackage(String configPackage)

getBasePackage

public String getBasePackage()

setBasePackage

public void setBasePackage(String basePackage)

setControllerOnly

public void setControllerOnly(boolean controllerOnly)

setUseInterfaces

public void setUseInterfaces(boolean useInterfaces)

setUseBeanValidation

public void setUseBeanValidation(boolean useBeanValidation)

指定者:

setUseBeanValidation 在接口中 BeanValidationFeatures

setHandleExceptions

public void setHandleExceptions(boolean handleExceptions)

setWrapCalls

public void setWrapCalls(boolean wrapCalls)

setUseSwaggerUI

public void setUseSwaggerUI(boolean useSwaggerUI)

postProcessOperationsWithModels

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

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 AbstractJavaCodegen

postProcessSupportingFileData

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

指定者:

postProcessSupportingFileData 在接口中 CodegenConfig

覆盖:

postProcessSupportingFileData 在类中 DefaultCodegen