public class DocletOptions extends Object
| Constructor and Description |
|---|
DocletOptions()
This creates a DocletOptions
|
| Modifier and Type | Method and Description |
|---|---|
ApiAuthorizations |
getApiAuthorizations()
This gets the apiAuthorizations
|
String |
getApiBasePath() |
List<String> |
getApiDescriptionTags()
This gets a list of javadoc tag names that can be used for the api description
|
ApiInfo |
getApiInfo()
This gets the apiInfo
|
String |
getApiVersion() |
List<String> |
getAuthOperationScopes()
This gets the authOperationScopes
|
List<String> |
getAuthOperationTags()
This gets the authOperationTags
|
List<String> |
getCompositeParamAnnotations()
This gets the compositeParamAnnotations
|
List<String> |
getCompositeParamTypes()
This gets the compositeParamTypes
|
List<String> |
getCsvParamsTags()
This gets the csvParamsTags
|
List<String> |
getDefaultErrorTypeTags()
This gets the defaultErrorTypeTags
|
List<String> |
getDiscriminatorAnnotations()
This gets the discriminatorAnnotations
|
String |
getDocBasePath() |
List<String> |
getExcludeClassTags()
This gets the excludeClassTags
|
List<String> |
getExcludeFieldTags()
This gets the excludeFieldTags
|
List<String> |
getExcludeModelPrefixes()
This gets prefixes of the FQN of model classes to exclude
|
List<String> |
getExcludeOperationTags()
This gets the excludeOperationTags
|
List<String> |
getExcludeParamAnnotations()
This gets the excludeParamAnnotations
|
List<String> |
getExcludeParamsTags()
This gets the excludeParamsTags
|
List<String> |
getExcludeResourcePrefixes()
This gets prefixes of the FQN of resource classes to exclude
|
List<ApiDeclaration> |
getExtraApiDeclarations()
This gets the extraApiDeclarations
|
List<String> |
getFieldDefaultTags()
This gets the fieldDefaultTags
|
List<String> |
getFieldDescriptionTags()
This gets list of javadoc tag names that can be used for the model field/method descriptions
|
List<String> |
getFieldFormatTags()
This gets the fieldFormatTags
|
List<String> |
getFieldMaxAnnotations() |
List<String> |
getFieldMaxTags()
This gets the fieldMaxTags
|
List<String> |
getFieldMinAnnotations() |
List<String> |
getFieldMinTags()
This gets the fieldMinTags
|
List<String> |
getFileParameterAnnotations()
This gets the fileParameterAnnotations
|
List<String> |
getFileParameterTypes()
This gets the fileParameterTypes
|
List<String> |
getFormParameterAnnotations()
This gets the formParameterAnnotations
|
List<String> |
getFormParameterTypes()
This gets the formParameterTypes
|
List<String> |
getGenericWrapperTypes()
This gets a list of FQN of types which simply wrap the
real underlying data type
|
List<String> |
getIncludeResourcePrefixes()
This gets prefixes of the FQN of resource classes to include, if specified then resources must match these
|
List<String> |
getInputTypeTags()
This gets tags that can customize the type for input body params
|
NamingConvention |
getModelFieldsNamingConvention()
This gets the modelFieldsNamingConvention
|
List<String> |
getOperationNotesTags()
This gets a list of javadoc tag names that can be used for the operation notes
|
List<String> |
getOperationScopeTags()
This gets the operationScopeTags
|
List<String> |
getOperationSummaryTags()
This gets a list of javadoc tag names that can be used for the operation summary
|
List<String> |
getOptionalFieldAnnotations() |
List<String> |
getOptionalFieldTags()
This gets the optionalFieldTags
|
List<String> |
getOptionalParamAnnotations() |
List<String> |
getOptionalParamsTags()
This gets the optionalParamsTags
|
File |
getOutputDirectory() |
List<String> |
getParameterNameAnnotations()
This gets the parameterNameAnnotations
|
List<String> |
getParamMaxValueAnnotations() |
List<String> |
getParamMinValueAnnotations() |
List<String> |
getParamsAllowableValuesTags()
This gets the paramsAllowableValuesTags
|
List<String> |
getParamsDefaultValueTags()
This gets the paramsDefaultValueTags
|
List<String> |
getParamsFormatTags()
This gets the paramsFormatTags
|
List<String> |
getParamsMaxValueTags()
This gets the paramsMaxValueTags
|
List<String> |
getParamsMinValueTags()
This gets the paramsMinValueTags
|
List<String> |
getParamsNameTags()
This gets the paramsNameTags
|
Recorder |
getRecorder() |
List<String> |
getRequiredFieldAnnotations() |
List<String> |
getRequiredFieldTags()
This gets the requiredFieldTags
|
List<String> |
getRequiredParamAnnotations() |
List<String> |
getRequiredParamsTags()
This gets the requiredParamsTags
|
List<String> |
getResourceDescriptionTags()
This gets list of javadoc tag names that can be used for the description of resources
|
List<String> |
getResourcePriorityTags()
This gets list of javadoc tag names that can be used for ordering resources in the resource listing
|
String |
getResourceRootPath()
This gets the resourceRootPath
|
List<String> |
getResourceTags()
This gets the resourceTags
|
ResponseMessageSortMode |
getResponseMessageSortMode()
This gets the responseMessageSortMode
|
List<String> |
getResponseMessageTags()
This gets the responseMessageTags
|
List<String> |
getResponseTypeTags()
This gets the responseTypeTags
|
List<String> |
getStringTypePrefixes()
This gets the stringTypePrefixes
|
List<String> |
getSubTypesAnnotations()
This gets the subTypesAnnotations
|
String |
getSwaggerUiPath()
This gets the swaggerUiPath
|
Translator |
getTranslator() |
List<String> |
getUnauthOperationTags()
This gets the unauthOperationTags
|
List<String> |
getUnauthOperationTagValues()
This gets the unauthOperationTagValues
|
boolean |
isExcludeDeprecatedFields()
This gets the excludeDeprecatedFields
|
boolean |
isExcludeDeprecatedModelClasses()
This gets the excludeDeprecatedModelClasses
|
boolean |
isExcludeDeprecatedOperations()
This gets the excludeDeprecatedOperations
|
boolean |
isExcludeDeprecatedParams()
This gets the excludeDeprecatedParams
|
boolean |
isExcludeDeprecatedResourceClasses()
This gets the excludeDeprecatedResourceClasses
|
boolean |
isIncludeSwaggerUi()
This gets the includeSwaggerUi
|
boolean |
isModelFieldsDefaultXmlAccessTypeEnabled()
This gets the modelFieldsDefaultXmlAccessTypeEnabled
|
boolean |
isModelFieldsRequiredByDefault()
This is whether model fields are required by default e.g.
|
boolean |
isModelFieldsXmlAccessTypeEnabled()
This gets the modelFieldsXmlAccessTypeEnabled
|
boolean |
isParseModels()
This is whether model parsing is enabled
|
boolean |
isSortApisByPath()
This gets the sortOperationsByPath
|
boolean |
isSortResourcesByPath()
This gets the sortResourcesByPath
|
boolean |
isSortResourcesByPriority()
This gets the sortResourcesByPriority
|
static DocletOptions |
parse(String[][] options)
This parses doclet options
|
String |
replaceVars(String value)
This replaces any variables in the given value with replacements defined in the doclets variable replacements file
|
DocletOptions |
setApiAuthorizations(ApiAuthorizations apiAuthorizations)
This sets the apiAuthorizations
|
DocletOptions |
setApiBasePath(String apiBasePath)
This sets the apiBasePath
|
DocletOptions |
setApiInfo(ApiInfo apiInfo)
This sets the apiInfo
|
DocletOptions |
setApiVersion(String apiVersion)
This sets the apiVersion
|
DocletOptions |
setDocBasePath(String docBasePath)
This sets the docBasePath
|
DocletOptions |
setExcludeDeprecatedFields(boolean excludeDeprecatedFields)
This sets the excludeDeprecatedFields
|
DocletOptions |
setExcludeDeprecatedOperations(boolean excludeDeprecatedOperations)
This sets the excludeDeprecatedOperations
|
DocletOptions |
setExcludeDeprecatedParams(boolean excludeDeprecatedParams)
This sets the excludeDeprecatedParams
|
DocletOptions |
setExcludeModelPrefixes(List<String> excludeModelPrefixes)
This sets the prefixes of the FQN of model classes to exclude
|
DocletOptions |
setExcludeResourcePrefixes(List<String> excludeResourcePrefixes)
This sets the prefixes of the FQN of resource classes to exclude
|
DocletOptions |
setExtraApiDeclarations(List<ApiDeclaration> extraApiDeclarations)
This sets the extraApiDeclarations
|
DocletOptions |
setIncludeResourcePrefixes(List<String> includeResourcePrefixes)
This sets the prefixes of the FQN of resource classes to include, if specified then resources must match these
|
DocletOptions |
setIncludeSwaggerUi(boolean includeSwaggerUi)
This sets the includeSwaggerUi
|
DocletOptions |
setModelFieldsDefaultXmlAccessTypeEnabled(boolean modelFieldsDefaultXmlAccessTypeEnabled)
This sets the modelFieldsDefaultXmlAccessTypeEnabled
|
DocletOptions |
setModelFieldsNamingConvention(NamingConvention modelFieldsNamingConvention)
This sets the modelFieldsNamingConvention
|
DocletOptions |
setModelFieldsRequiredByDefault(boolean modelFieldsRequiredByDefault)
This sets the modelFieldsRequiredByDefault
|
DocletOptions |
setModelFieldsXmlAccessTypeEnabled(boolean modelFieldsXmlAccessTypeEnabled)
This sets the modelFieldsXmlAccessTypeEnabled
|
DocletOptions |
setRecorder(Recorder recorder) |
DocletOptions |
setResourceRootPath(String resourceRootPath)
This sets the resourceRootPath
|
DocletOptions |
setResponseMessageSortMode(ResponseMessageSortMode responseMessageSortMode)
This sets the responseMessageSortMode
|
DocletOptions |
setSortApisByPath(boolean sortApisByPath)
This sets the sortApisByPath
|
DocletOptions |
setSortResourcesByPath(boolean sortResourcesByPath)
This sets the sortResourcesByPath
|
DocletOptions |
setSortResourcesByPriority(boolean sortResourcesByPriority)
This sets the sortResourcesByPriority
|
DocletOptions |
setTranslator(Translator translator) |
DocletOptions |
setVariableReplacements(Properties variableReplacements)
This sets the variable replacements to use
|
public static DocletOptions parse(String[][] options)
options - The cmdline optionspublic File getOutputDirectory()
public String getDocBasePath()
public DocletOptions setDocBasePath(String docBasePath)
docBasePath - the docBasePath to setpublic String getResourceRootPath()
public DocletOptions setResourceRootPath(String resourceRootPath)
resourceRootPath - the resourceRootPath to setpublic String getApiBasePath()
public DocletOptions setApiBasePath(String apiBasePath)
apiBasePath - the apiBasePath to setpublic String getApiVersion()
public DocletOptions setApiVersion(String apiVersion)
apiVersion - the apiVersion to setpublic String getSwaggerUiPath()
public List<String> getResponseMessageTags()
public List<String> getExcludeOperationTags()
public List<String> getExcludeClassTags()
public List<String> getExcludeFieldTags()
public List<String> getExcludeParamAnnotations()
public List<String> getExcludeParamsTags()
public List<String> getCsvParamsTags()
public List<String> getParamsFormatTags()
public List<String> getParamsMinValueTags()
public List<String> getParamsMaxValueTags()
public List<String> getParamsDefaultValueTags()
public List<String> getParamsAllowableValuesTags()
public List<String> getParamsNameTags()
public List<String> getResourceTags()
public List<String> getExcludeResourcePrefixes()
public DocletOptions setExcludeResourcePrefixes(List<String> excludeResourcePrefixes)
excludeResourcePrefixes - the prefixes of the FQN of resource classes to excludepublic List<String> getIncludeResourcePrefixes()
public DocletOptions setIncludeResourcePrefixes(List<String> includeResourcePrefixes)
includeResourcePrefixes - the prefixes of the FQN of resource classes to include, if specified then resources must match thesepublic List<String> getDiscriminatorAnnotations()
public List<String> getSubTypesAnnotations()
public List<String> getExcludeModelPrefixes()
public DocletOptions setExcludeModelPrefixes(List<String> excludeModelPrefixes)
excludeModelPrefixes - prefixes of the FQN of model classes to excludepublic List<String> getGenericWrapperTypes()
public List<String> getFileParameterAnnotations()
public List<String> getFileParameterTypes()
public List<String> getFormParameterAnnotations()
public List<String> getFormParameterTypes()
public List<String> getCompositeParamAnnotations()
public List<String> getCompositeParamTypes()
public List<String> getParameterNameAnnotations()
public List<String> getStringTypePrefixes()
public boolean isParseModels()
public boolean isModelFieldsRequiredByDefault()
public DocletOptions setModelFieldsRequiredByDefault(boolean modelFieldsRequiredByDefault)
modelFieldsRequiredByDefault - the modelFieldsRequiredByDefault to setpublic boolean isModelFieldsXmlAccessTypeEnabled()
public DocletOptions setModelFieldsXmlAccessTypeEnabled(boolean modelFieldsXmlAccessTypeEnabled)
modelFieldsXmlAccessTypeEnabled - the modelFieldsXmlAccessTypeEnabled to setpublic boolean isModelFieldsDefaultXmlAccessTypeEnabled()
public DocletOptions setModelFieldsDefaultXmlAccessTypeEnabled(boolean modelFieldsDefaultXmlAccessTypeEnabled)
modelFieldsDefaultXmlAccessTypeEnabled - the modelFieldsDefaultXmlAccessTypeEnabled to setpublic NamingConvention getModelFieldsNamingConvention()
public DocletOptions setModelFieldsNamingConvention(NamingConvention modelFieldsNamingConvention)
modelFieldsNamingConvention - the modelFieldsNamingConvention to setpublic List<String> getResponseTypeTags()
public List<String> getInputTypeTags()
public List<String> getDefaultErrorTypeTags()
public List<String> getApiDescriptionTags()
public List<String> getOperationNotesTags()
public List<String> getOperationSummaryTags()
public List<String> getFieldDescriptionTags()
public List<String> getResourcePriorityTags()
public List<String> getResourceDescriptionTags()
public List<String> getFieldFormatTags()
public List<String> getFieldMinTags()
public List<String> getFieldMaxTags()
public List<String> getFieldDefaultTags()
public List<String> getRequiredParamsTags()
public List<String> getOptionalParamsTags()
public List<String> getRequiredFieldTags()
public List<String> getOptionalFieldTags()
public List<String> getUnauthOperationTags()
public List<String> getAuthOperationTags()
public List<String> getUnauthOperationTagValues()
public List<String> getOperationScopeTags()
public List<String> getAuthOperationScopes()
public Recorder getRecorder()
public DocletOptions setRecorder(Recorder recorder)
public Translator getTranslator()
public DocletOptions setTranslator(Translator translator)
public boolean isSortResourcesByPath()
public DocletOptions setSortResourcesByPath(boolean sortResourcesByPath)
sortResourcesByPath - the sortResourcesByPath to setpublic boolean isSortResourcesByPriority()
public DocletOptions setSortResourcesByPriority(boolean sortResourcesByPriority)
sortResourcesByPriority - the sortResourcesByPriority to setpublic boolean isSortApisByPath()
public DocletOptions setSortApisByPath(boolean sortApisByPath)
sortApisByPath - the sortApisByPath to setpublic boolean isIncludeSwaggerUi()
public DocletOptions setIncludeSwaggerUi(boolean includeSwaggerUi)
includeSwaggerUi - the includeSwaggerUi to setpublic boolean isExcludeDeprecatedResourceClasses()
public boolean isExcludeDeprecatedModelClasses()
public boolean isExcludeDeprecatedOperations()
public DocletOptions setExcludeDeprecatedOperations(boolean excludeDeprecatedOperations)
excludeDeprecatedOperations - the excludeDeprecatedOperations to setpublic boolean isExcludeDeprecatedFields()
public DocletOptions setExcludeDeprecatedFields(boolean excludeDeprecatedFields)
excludeDeprecatedFields - the excludeDeprecatedFields to setpublic boolean isExcludeDeprecatedParams()
public DocletOptions setExcludeDeprecatedParams(boolean excludeDeprecatedParams)
excludeDeprecatedParams - the excludeDeprecatedParams to setpublic ResponseMessageSortMode getResponseMessageSortMode()
public DocletOptions setResponseMessageSortMode(ResponseMessageSortMode responseMessageSortMode)
responseMessageSortMode - the responseMessageSortMode to setpublic ApiAuthorizations getApiAuthorizations()
public DocletOptions setApiAuthorizations(ApiAuthorizations apiAuthorizations)
apiAuthorizations - the apiAuthorizations to setpublic ApiInfo getApiInfo()
public DocletOptions setApiInfo(ApiInfo apiInfo)
apiInfo - the apiInfo to setpublic List<ApiDeclaration> getExtraApiDeclarations()
public DocletOptions setExtraApiDeclarations(List<ApiDeclaration> extraApiDeclarations)
extraApiDeclarations - the extraApiDeclarations to setpublic DocletOptions setVariableReplacements(Properties variableReplacements)
variableReplacements - properties to use for variable replacementsCopyright © 2015. All rights reserved.