io.swagger.codegen.languages

Class JavaPlayFrameworkCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.AbstractJavaCodegen

io.swagger.codegen.languages.JavaPlayFrameworkCodegen

All Implemented Interfaces:

CodegenConfig, BeanValidationFeatures

public class JavaPlayFrameworkCodegen
extends AbstractJavaCodegen
implements BeanValidationFeatures

Field Summary

Fields

Modifier and Type	Field and Description
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

Fields inherited from class io.swagger.codegen.languages.AbstractJavaCodegen

ADDITIONAL_MODEL_TYPE_ANNOTATIONS, additionalModelTypeAnnotations, apiDocPath, artifactDescription, artifactId, artifactUrl, artifactVersion, CHECK_DUPLICATED_MODEL_NAME, DATE_LIBRARY, dateLibrary, DEFAULT_LIBRARY, developerEmail, developerName, developerOrganization, developerOrganizationUrl, DISABLE_HTML_ESCAPING, disableHtmlEscaping, ERROR_ON_UNKNOWN_ENUM, FULL_JAVA_UTIL, fullJavaUtil, groupId, invokerPackage, JAVA11_MODE, java11Mode, JAVA8_MODE, java8Mode, javaUtilPrefix, licenseName, licenseUrl, localVariablePrefix, modelDocPath, projectFolder, projectTestFolder, scmConnection, scmDeveloperConnection, scmUrl, serializableModel, serializeBigDecimalAsString, sourceFolder, SUPPORT_ASYNC, SUPPORT_JAVA6, supportAsync, supportJava6, testFolder, WITH_XML, withXml

Fields inherited from class io.swagger.codegen.DefaultCodegen

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

Fields inherited from interface io.swagger.codegen.languages.features.BeanValidationFeatures

USE_BEANVALIDATION

Constructor Summary

Constructors

Constructor and Description
JavaPlayFrameworkCodegen()

Method Summary

Modifier and Type	Method and Description
CodegenModel	fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions) Convert Swagger Model object to Codegen Model object
String	getHelp()
String	getName()
CodegenType	getTag()
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	processOpts()
void	setBasePackage(String configPackage)
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)

Methods inherited from class io.swagger.codegen.languages.AbstractJavaCodegen

apiDocFileFolder, apiFileFolder, apiTestFileFolder, checkDuplicatedModelNameIgnoringCase, convertPropertyToBoolean, defaultIgnoreImportMappingOption, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fixUpParentAndInterfaces, fromOperation, getAlias, getInvokerPackage, getSwaggerType, getTypeDeclaration, modelDocFileFolder, modelFileFolder, needToImport, postProcessAllModels, postProcessModels, postProcessParameter, preprocessSwagger, replaceDuplicatedInModelProperties, replaceDuplicatedInPaths, sanitizeTag, setAdditionalModelTypeAnnotations, setArtifactDescription, setArtifactId, setArtifactUrl, setArtifactVersion, setDateLibrary, setDeveloperEmail, setDeveloperName, setDeveloperOrganization, setDeveloperOrganizationUrl, setDisableHtmlEscaping, setFullJavaUtil, setGroupId, setInvokerPackage, setJava11Mode, setJava8Mode, setLicenseName, setLicenseUrl, setLocalVariablePrefix, setParameterExampleValue, setScmConnection, setScmDeveloperConnection, setScmUrl, setSerializableModel, setSerializeBigDecimalAsString, setSourceFolder, setSupportAsync, setSupportJava6, setTestFolder, 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.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configureDataForTestTemplate, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, ensureUniqueName, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromModel, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getCommonTemplateDir, getExamples, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterDataType, getReleaseNote, getSkipAliasGeneration, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isHideGenerationTimestamp, isModelObject, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, isUsingFlattenSpec, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessModelProperties, postProcessModelsEnum, postProcessOperationsWithModels, processCompiler, processSwagger, readRefModelParameter, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipAliasGeneration, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, titleCase, toApiImport, toApiVarName, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toGetter, toInstantiationType, toModelImport, toModelTestFilename, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, 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.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, fileSuffix, fromModel, fromOperation, fromSecurity, generateExamplePath, getCommonTemplateDir, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSkipAliasGeneration, getTypeDeclaration, importMapping, instantiationTypes, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isUsingFlattenSpec, languageSpecificPrimitives, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessOperationsWithModels, processCompiler, processSwagger, reservedWords, reservedWordsMappings, sanitizeName, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipAliasGeneration, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiImport, toApiVarName, toGetter, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

Field Detail

TITLE

public static final String TITLE

See Also:

Constant Field Values

CONFIG_PACKAGE

public static final String CONFIG_PACKAGE

See Also:

Constant Field Values

BASE_PACKAGE

public static final String BASE_PACKAGE

See Also:

Constant Field Values

CONTROLLER_ONLY

public static final String CONTROLLER_ONLY

See Also:

Constant Field Values

USE_INTERFACES

public static final String USE_INTERFACES

See Also:

Constant Field Values

HANDLE_EXCEPTIONS

public static final String HANDLE_EXCEPTIONS

See Also:

Constant Field Values

WRAP_CALLS

public static final String WRAP_CALLS

See Also:

Constant Field Values

USE_SWAGGER_UI

public static final String USE_SWAGGER_UI

See Also:

Constant Field Values

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

Constructor Detail

JavaPlayFrameworkCodegen

public JavaPlayFrameworkCodegen()

Method Detail

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

getName

public String getName()

Specified by:

getName in interface CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractJavaCodegen

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

Specified by:

postProcessModelProperty in interface CodegenConfig

Overrides:

postProcessModelProperty in class AbstractJavaCodegen

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.models.Model model,
                              Map<String,io.swagger.models.Model> allDefinitions)

Description copied from class: DefaultCodegen

Convert Swagger Model object to Codegen Model object

Specified by:

fromModel in interface CodegenConfig

Overrides:

fromModel in class AbstractJavaCodegen

Parameters:

name - the name of the model

model - Swagger Model object

allDefinitions - a map of all Swagger models from the spec

Returns:

Codegen Model object

setTitle

public void setTitle(String title)

setConfigPackage

public void setConfigPackage(String configPackage)

setBasePackage

public void setBasePackage(String configPackage)

setControllerOnly

public void setControllerOnly(boolean controllerOnly)

setUseInterfaces

public void setUseInterfaces(boolean useInterfaces)

setUseBeanValidation

public void setUseBeanValidation(boolean useBeanValidation)

Specified by:

setUseBeanValidation in interface BeanValidationFeatures

setHandleExceptions

public void setHandleExceptions(boolean handleExceptions)

setWrapCalls

public void setWrapCalls(boolean wrapCalls)

setUseSwaggerUI

public void setUseSwaggerUI(boolean useSwaggerUI)

postProcessOperations

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

Specified by:

postProcessOperations in interface CodegenConfig

Overrides:

postProcessOperations in class AbstractJavaCodegen

postProcessSupportingFileData

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

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen