DocletOptions (swagger-doclet 1.0.5 API)

java.lang.Object
- com.carma.swagger.doclet.DocletOptions

```
public class DocletOptions
extends Object
```
The DocletOptions represents the supported options for this doclet.

Version:

$Id$

Constructor Summary

Constructors
Constructor and Description

DocletOptions()
This creates a DocletOptions

Constructors
Constructor and Description
`DocletOptions()` This creates a DocletOptions

Method Summary

Methods
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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class DocletOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocletOptions

Method Detail

parse

getOutputDirectory

getDocBasePath

setDocBasePath

getResourceRootPath

setResourceRootPath

getApiBasePath

setApiBasePath

getApiVersion

setApiVersion

getSwaggerUiPath

getResponseMessageTags

getExcludeOperationTags

getExcludeClassTags

getExcludeFieldTags

getExcludeParamAnnotations

getExcludeParamsTags

getCsvParamsTags

getParamsFormatTags

getParamsMinValueTags

getParamsMaxValueTags

getParamsDefaultValueTags

getParamsAllowableValuesTags

getParamsNameTags

getResourceTags

getExcludeResourcePrefixes

setExcludeResourcePrefixes

getIncludeResourcePrefixes

setIncludeResourcePrefixes

getDiscriminatorAnnotations

getSubTypesAnnotations

getExcludeModelPrefixes

setExcludeModelPrefixes

getGenericWrapperTypes

getFileParameterAnnotations

getFileParameterTypes

getFormParameterAnnotations

getFormParameterTypes

getCompositeParamAnnotations

getCompositeParamTypes

getParameterNameAnnotations

getStringTypePrefixes

isParseModels

isModelFieldsRequiredByDefault

setModelFieldsRequiredByDefault

isModelFieldsXmlAccessTypeEnabled

setModelFieldsXmlAccessTypeEnabled

isModelFieldsDefaultXmlAccessTypeEnabled

setModelFieldsDefaultXmlAccessTypeEnabled

getModelFieldsNamingConvention

setModelFieldsNamingConvention

getResponseTypeTags

getInputTypeTags

getDefaultErrorTypeTags

getApiDescriptionTags

getOperationNotesTags

getOperationSummaryTags

getFieldDescriptionTags

getResourcePriorityTags

getResourceDescriptionTags

getFieldFormatTags

getFieldMinTags

getFieldMaxTags

getFieldDefaultTags

getRequiredParamsTags

getOptionalParamsTags

getRequiredFieldTags

getOptionalFieldTags

getParamMinValueAnnotations

getParamMaxValueAnnotations

getFieldMinAnnotations

getFieldMaxAnnotations

getRequiredParamAnnotations