Uses of Class
com.carma.swagger.doclet.DocletOptions

Packages that use DocletOptions

Package	Description
com.carma.swagger.doclet
com.carma.swagger.doclet.parser
com.carma.swagger.doclet.translator

Uses of DocletOptions in com.carma.swagger.doclet

Methods in com.carma.swagger.doclet that return DocletOptions

Modifier and Type	Method and Description
static DocletOptions	DocletOptions.parse(String[][] options) This parses doclet options
DocletOptions	DocletOptions.setApiAuthorizations(ApiAuthorizations apiAuthorizations) This sets the apiAuthorizations
DocletOptions	DocletOptions.setApiBasePath(String apiBasePath) This sets the apiBasePath
DocletOptions	DocletOptions.setApiInfo(ApiInfo apiInfo) This sets the apiInfo
DocletOptions	DocletOptions.setApiVersion(String apiVersion) This sets the apiVersion
DocletOptions	DocletOptions.setDocBasePath(String docBasePath) This sets the docBasePath
DocletOptions	DocletOptions.setExcludeDeprecatedFields(boolean excludeDeprecatedFields) This sets the excludeDeprecatedFields
DocletOptions	DocletOptions.setExcludeDeprecatedOperations(boolean excludeDeprecatedOperations) This sets the excludeDeprecatedOperations
DocletOptions	DocletOptions.setExcludeDeprecatedParams(boolean excludeDeprecatedParams) This sets the excludeDeprecatedParams
DocletOptions	DocletOptions.setExcludeModelPrefixes(List<String> excludeModelPrefixes) This sets the prefixes of the FQN of model classes to exclude
DocletOptions	DocletOptions.setExcludeResourcePrefixes(List<String> excludeResourcePrefixes) This sets the prefixes of the FQN of resource classes to exclude
DocletOptions	DocletOptions.setExtraApiDeclarations(List<ApiDeclaration> extraApiDeclarations) This sets the extraApiDeclarations
DocletOptions	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	DocletOptions.setIncludeSwaggerUi(boolean includeSwaggerUi) This sets the includeSwaggerUi
DocletOptions	DocletOptions.setModelFieldsDefaultXmlAccessTypeEnabled(boolean modelFieldsDefaultXmlAccessTypeEnabled) This sets the modelFieldsDefaultXmlAccessTypeEnabled
DocletOptions	DocletOptions.setModelFieldsNamingConvention(NamingConvention modelFieldsNamingConvention) This sets the modelFieldsNamingConvention
DocletOptions	DocletOptions.setModelFieldsRequiredByDefault(boolean modelFieldsRequiredByDefault) This sets the modelFieldsRequiredByDefault
DocletOptions	DocletOptions.setModelFieldsXmlAccessTypeEnabled(boolean modelFieldsXmlAccessTypeEnabled) This sets the modelFieldsXmlAccessTypeEnabled
DocletOptions	DocletOptions.setRecorder(Recorder recorder)
DocletOptions	DocletOptions.setResourceRootPath(String resourceRootPath) This sets the resourceRootPath
DocletOptions	DocletOptions.setResponseMessageSortMode(ResponseMessageSortMode responseMessageSortMode) This sets the responseMessageSortMode
DocletOptions	DocletOptions.setSortApisByPath(boolean sortApisByPath) This sets the sortApisByPath
DocletOptions	DocletOptions.setSortResourcesByPath(boolean sortResourcesByPath) This sets the sortResourcesByPath
DocletOptions	DocletOptions.setSortResourcesByPriority(boolean sortResourcesByPriority) This sets the sortResourcesByPriority
DocletOptions	DocletOptions.setTranslator(Translator translator)
DocletOptions	DocletOptions.setVariableReplacements(Properties variableReplacements) This sets the variable replacements to use

Uses of DocletOptions in com.carma.swagger.doclet.parser

Methods in com.carma.swagger.doclet.parser with parameters of type DocletOptions

Modifier and Type	Method and Description
static String	ParserHelper.fieldParamNameOf(com.sun.javadoc.FieldDoc field, Map<String,String> overrideParamNames, List<String> paramNameAnnotations, DocletOptions options) Determines the string representation of the parameter name.
static String	ParserHelper.getAnnotationOrTagValue(com.sun.javadoc.ProgramElementDoc item, Collection<String> annotations, Collection<String> matchTags, DocletOptions options, String... valueKeys) This gets the first value on the given item (field or method) that matches either an annotation or a javadoc tag.
static List<String>	ParserHelper.getConsumes(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options) This gets the list of consumes mime types from the given method
static List<String>	ParserHelper.getCsvParams(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, DocletOptions options) This gets a list of parameter names from a method javadoc tag where the value of the tag is in the form paramName1,paramName2 ...
static String	ParserHelper.getDefaultValue(com.sun.javadoc.Parameter param, DocletOptions options) This gets the default value of the given parameter
static String	ParserHelper.getInheritableClassLevelAnnotationValue(com.sun.javadoc.ClassDoc classDoc, DocletOptions options, String qualifiedAnnotationType, String... keys) This gets an annotation value from the given class, it supports looking at super classes
static com.sun.javadoc.ClassDoc[]	ParserHelper.getInheritableJsonViews(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options) This gets the json views for the given method, it supports deriving the views from an overridden method
static String	ParserHelper.getInheritableTagValue(com.sun.javadoc.ExecutableMemberDoc methodDoc, Collection<String> matchTags, DocletOptions options) This gets the value of the first tag found from the given MethodDoc respecting the overriden methods
static List<String>	ParserHelper.getInheritableTagValues(com.sun.javadoc.ExecutableMemberDoc methodDoc, Collection<String> matchTags, DocletOptions options) This gets values of any of the javadoc tags that are in the given collection from the method or overridden methods
static com.sun.javadoc.ClassDoc[]	ParserHelper.getJsonViews(com.sun.javadoc.ProgramElementDoc doc, DocletOptions options) This gets the json views for the given method/field
static Set<String>	ParserHelper.getMatchingParams(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> javadocTags, Collection<String> annotations, DocletOptions options) This gets params of the given method that have either any of the matching javadoc tags or annotations
static Map<String,List<String>>	ParserHelper.getMethodParamNameValueLists(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, DocletOptions options) This gets a map of parameter name to list of values from a javadoc tag on a method.
static Map<String,String>	ParserHelper.getMethodParamNameValuePairs(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, DocletOptions options) This gets a map of parameter name to value from a javadoc tag on a method.
static Map<String,String>	ParserHelper.getParameterValues(com.sun.javadoc.ExecutableMemberDoc method, Set<String> params, Collection<String> matchTags, Collection<String> annotations, ParserHelper.TypeFilter annotationTypes, DocletOptions options, String... valueKeys) This gets the values of parameters from either javadoc tags or annotations
static Map<String,String>	ParserHelper.getParameterValuesWithAnnotation(com.sun.javadoc.ExecutableMemberDoc methodDoc, Collection<String> annotations, ParserHelper.TypeFilter annotationTypes, DocletOptions options, String... valueKeys) This gets the values of annotations of parameters that have any of the given annotations on them
static List<String>	ParserHelper.getProduces(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options) This gets the list of produces mime types from the given method
static com.sun.javadoc.Type	ApiModelParser.getReturnType(DocletOptions options, com.sun.javadoc.Type type) This gets the return type for a resource method, it supports wrapper types
static List<String>	ParserHelper.getTagCsvValues(com.sun.javadoc.ExecutableMemberDoc item, Collection<String> matchTags, DocletOptions options) This gets a csv javadoc tag value as a list of the values in the csv for the first matched tag.
static String	ParserHelper.getTagValue(com.sun.javadoc.ProgramElementDoc item, Collection<String> matchTags, DocletOptions options) This gets the value of the first tag found from the given collection of tag names
static List<String>	ParserHelper.getTagValues(com.sun.javadoc.ProgramElementDoc item, Collection<String> matchTags, DocletOptions options) This gets values of any of the javadoc tags that are in the given collection
static boolean	ParserHelper.hasAnnotation(com.sun.javadoc.Parameter item, Collection<String> annotations, DocletOptions options) This gets whether the given parameter has one of the given annotations
static boolean	ParserHelper.hasAnnotation(com.sun.javadoc.ProgramElementDoc item, Collection<String> annotations, DocletOptions options) This gets whether the given item has one of the given annotations
static boolean	ParserHelper.hasAnnotationWithPrefix(com.sun.javadoc.Parameter item, Collection<String> prefixes, DocletOptions options) This gets whether the given parameter has an annotation whose FQN begins with one of the given prefixes
static boolean	ParserHelper.hasInheritableAnnotation(com.sun.javadoc.MethodDoc methodDoc, Collection<String> annotations, DocletOptions options) This gets whether the given method or an overridden method has any of the given annotations
static boolean	ParserHelper.hasJaxRsAnnotation(com.sun.javadoc.Parameter item, DocletOptions options) This gets whether the given parameter has a JAXRS annotation
static boolean	ParserHelper.hasJsonViews(com.sun.javadoc.ProgramElementDoc doc, DocletOptions options) This gets whether the given method/field has a json view on it
static boolean	ParserHelper.isDeprecated(com.sun.javadoc.Parameter parameter, DocletOptions options) This gets whether the given parameter is marked as deprecated either via a javadoc tag or an annotation
static boolean	ParserHelper.isDeprecated(com.sun.javadoc.ProgramElementDoc item, DocletOptions options) This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation
static boolean	ParserHelper.isFileParameterDataType(com.sun.javadoc.Parameter parameter, DocletOptions options) This gets whether the given parameter is a File data type
static boolean	ParserHelper.isInheritableDeprecated(com.sun.javadoc.MethodDoc item, DocletOptions options) This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation, this supports looking at overridden methods
static boolean	ParserHelper.isNumber(com.sun.javadoc.Type type, DocletOptions options) This gets whether the given type is primitive
static boolean	ParserHelper.isPrimitive(String type, DocletOptions options) This gets whether the given type is primitive
static boolean	ParserHelper.isPrimitive(com.sun.javadoc.Type type, DocletOptions options) This gets whether the given type is primitive
static List<String>	ParserHelper.listInheritableValues(com.sun.javadoc.ExecutableMemberDoc methodDoc, String qualifiedAnnotationType, String annotationValueName, DocletOptions options) This gets a list of values from an annotation that uses a string array value, it supports getting it from a superclass method
static List<String>	ParserHelper.listValues(com.sun.javadoc.ProgramElementDoc doc, String qualifiedAnnotationType, String annotationValueName, DocletOptions options) This gets a list of values from an annotation that uses a string array value
static String	ParserHelper.paramNameOf(com.sun.javadoc.Parameter parameter, Map<String,String> overrideParamNames, List<String> paramNameAnnotations, DocletOptions options) Determines the string representation of the parameter name.
static String	ParserHelper.paramTypeOf(boolean returnDefault, boolean multipart, com.sun.javadoc.ProgramElementDoc paramMember, com.sun.javadoc.Type type, DocletOptions options) Determines the string representation of the parameter type for composite types.
static String	ParserHelper.paramTypeOf(boolean multipart, com.sun.javadoc.Parameter parameter, DocletOptions options) Determines the string representation of the parameter type.
static String	ParserHelper.parsePath(com.sun.javadoc.ProgramElementDoc doc, DocletOptions options) This parses the path from the annotations of a method or class
static String	ParserHelper.resolveMethodPath(com.sun.javadoc.MethodDoc methodDoc, DocletOptions options) Resolves tha @Path for the MethodDoc respecting the overriden methods
static String[]	ParserHelper.typeOf(String javaType, DocletOptions options) Determines the String representation of the given FQN.
static String[]	ParserHelper.typeOf(com.sun.javadoc.Type type, DocletOptions options) Determines the String representation of the object Type.

Constructors in com.carma.swagger.doclet.parser with parameters of type DocletOptions

Constructor and Description
AnnotationParser(com.sun.javadoc.Parameter parameter, DocletOptions options) This creates an AnnotationParser for a parameter
AnnotationParser(com.sun.javadoc.ProgramElementDoc element, DocletOptions options) This creates an AnnotationParser for a method/field
ApiMethodParser(DocletOptions options, Method parentMethod, com.sun.javadoc.MethodDoc methodDoc, Collection<com.sun.javadoc.ClassDoc> classes, Collection<com.sun.javadoc.ClassDoc> typeClasses, String classDefaultErrorType) This creates a ApiMethodParser
ApiMethodParser(DocletOptions options, String parentPath, com.sun.javadoc.MethodDoc methodDoc, Collection<com.sun.javadoc.ClassDoc> classes, Collection<com.sun.javadoc.ClassDoc> typeClasses, String classDefaultErrorType) This creates a ApiMethodParser
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType) This creates a ApiModelParser
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, boolean inheritFields) This creates a ApiModelParser
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, boolean consumesMultipart, boolean inheritFields) This creates a ApiModelParser for use when using composite parameter model parsing
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, com.sun.javadoc.ClassDoc[] viewClasses) This creates a ApiModelParser
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, com.sun.javadoc.ClassDoc[] viewClasses, boolean inheritFields) This creates a ApiModelParser
CrossClassApiParser(DocletOptions options, com.sun.javadoc.ClassDoc classDoc, Collection<com.sun.javadoc.ClassDoc> classes, Map<com.sun.javadoc.Type,com.sun.javadoc.ClassDoc> subResourceClasses, Collection<com.sun.javadoc.ClassDoc> typeClasses, String swaggerVersion, String apiVersion, String basePath) This creates a CrossClassApiParser for top level parsing
CrossClassApiParser(DocletOptions options, com.sun.javadoc.ClassDoc classDoc, Collection<com.sun.javadoc.ClassDoc> classes, Map<com.sun.javadoc.Type,com.sun.javadoc.ClassDoc> subResourceClasses, Collection<com.sun.javadoc.ClassDoc> typeClasses, String swaggerVersion, String apiVersion, String basePath, Method parentMethod, String parentResourcePath) This creates a CrossClassApiParser for parsing a subresource
JaxRsAnnotationParser(DocletOptions options, com.sun.javadoc.RootDoc rootDoc)
ParameterReader(DocletOptions options, Collection<com.sun.javadoc.ClassDoc> allClasses) This creates a PathParameterReader
ParserHelper.NumericTypeFilter(DocletOptions options)

Uses of DocletOptions in com.carma.swagger.doclet.translator

Constructors in com.carma.swagger.doclet.translator with parameters of type DocletOptions

Constructor and Description
AnnotationAwareTranslator(DocletOptions options) This creates a AnnotationAwareTranslator that uses the given doclet options
NameBasedTranslator(DocletOptions options) This creates a NameBasedTranslator