A B C D E F G H I J L M N O P Q R S T V

A

addNext(Translator) - Method in class com.carma.swagger.doclet.translator.FirstNotNullTranslator

This adds another translator link to the chain of translators

addVarsToTypes(Map<String, Type>) - Method in class com.carma.swagger.doclet.parser.ApiModelParser

This adds the given vars to types to the ones used by this model

AnnotationAwareTranslator - Class in com.carma.swagger.doclet.translator

The AnnotationAwareTranslator represents a translator that can source the names from various annotations like jaxb and json ones.

AnnotationAwareTranslator(DocletOptions) - Constructor for class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

This creates a AnnotationAwareTranslator that uses the given doclet options

AnnotationParser - Class in com.carma.swagger.doclet.parser

The AnnotationParser represents a utility class for reading values from annotations

AnnotationParser(ProgramElementDoc, DocletOptions) - Constructor for class com.carma.swagger.doclet.parser.AnnotationParser

This creates an AnnotationParser for a method/field

AnnotationParser(Parameter, DocletOptions) - Constructor for class com.carma.swagger.doclet.parser.AnnotationParser

This creates an AnnotationParser for a parameter

Api - Class in com.carma.swagger.doclet.model

Api(String, String, Collection<Operation>) - Constructor for class com.carma.swagger.doclet.model.Api

ApiAuthorizations - Class in com.carma.swagger.doclet.model

The ApiAuthorizations represents the authorizations element for the API

ApiAuthorizations() - Constructor for class com.carma.swagger.doclet.model.ApiAuthorizations

This creates an empty Authorizations

ApiAuthorizations(ApiOauth2Authorization) - Constructor for class com.carma.swagger.doclet.model.ApiAuthorizations

This creates an Authorizations for oauth2

ApiAuthorizations(ApiBasicAuthorization) - Constructor for class com.carma.swagger.doclet.model.ApiAuthorizations

This creates a ApiAuthorizations for basic auth

ApiAuthorizations(ApiKeyAuthorization) - Constructor for class com.carma.swagger.doclet.model.ApiAuthorizations

This creates a ApiAuthorizations for api key type auth

ApiBasicAuthorization - Class in com.carma.swagger.doclet.model

The ApiBasicAuthorization represents the

ApiBasicAuthorization() - Constructor for class com.carma.swagger.doclet.model.ApiBasicAuthorization

This creates a ApiBasicAuthorization

ApiDeclaration - Class in com.carma.swagger.doclet.model

ApiDeclaration(String, String, String, String, List<Api>, Map<String, Model>, int, String) - Constructor for class com.carma.swagger.doclet.model.ApiDeclaration

ApiDeclarationMerger - Class in com.carma.swagger.doclet.parser

The ApiDeclarationMerger represents a util that can merge api declarations together based on the resource path

ApiDeclarationMerger(String, String, String) - Constructor for class com.carma.swagger.doclet.parser.ApiDeclarationMerger

This creates a ApiDeclarationMerger

ApiInfo - Class in com.carma.swagger.doclet.model

The ApiInfo represents the info regarding the API

ApiInfo() - Constructor for class com.carma.swagger.doclet.model.ApiInfo

This creates a ApiInfo

ApiInfo(String, String, String, String, String, String) - Constructor for class com.carma.swagger.doclet.model.ApiInfo

This creates a ApiInfo

ApiKeyAuthorization - Class in com.carma.swagger.doclet.model

The ApiKeyAuthorization represents the API Key authorization type

ApiKeyAuthorization() - Constructor for class com.carma.swagger.doclet.model.ApiKeyAuthorization

This creates a ApiKeyAuthorization

ApiKeyAuthorization(String, String) - Constructor for class com.carma.swagger.doclet.model.ApiKeyAuthorization

This creates a ApiKeyAuthorization

ApiMethodParser - Class in com.carma.swagger.doclet.parser

The ApiMethodParser represents a parser for resource methods

ApiMethodParser(DocletOptions, String, MethodDoc, Collection<ClassDoc>, Collection<ClassDoc>, String) - Constructor for class com.carma.swagger.doclet.parser.ApiMethodParser

This creates a ApiMethodParser

ApiMethodParser(DocletOptions, Method, MethodDoc, Collection<ClassDoc>, Collection<ClassDoc>, String) - Constructor for class com.carma.swagger.doclet.parser.ApiMethodParser

This creates a ApiMethodParser

ApiModelParser - Class in com.carma.swagger.doclet.parser

The ApiModelParser represents a parser for api model classes which are used for parameters, resource method return types and model fields.

ApiModelParser(DocletOptions, Translator, Type) - Constructor for class com.carma.swagger.doclet.parser.ApiModelParser

This creates a ApiModelParser

ApiModelParser(DocletOptions, Translator, Type, boolean) - Constructor for class com.carma.swagger.doclet.parser.ApiModelParser

This creates a ApiModelParser

ApiModelParser(DocletOptions, Translator, Type, ClassDoc[]) - Constructor for class com.carma.swagger.doclet.parser.ApiModelParser

This creates a ApiModelParser

ApiModelParser(DocletOptions, Translator, Type, ClassDoc[], boolean) - Constructor for class com.carma.swagger.doclet.parser.ApiModelParser

This creates a ApiModelParser

ApiModelParser(DocletOptions, Translator, Type, boolean, boolean) - Constructor for class com.carma.swagger.doclet.parser.ApiModelParser

This creates a ApiModelParser for use when using composite parameter model parsing

ApiOauth2Authorization - Class in com.carma.swagger.doclet.model

The ApiOauth2Authorization represents the oauth 2 authorization for the api authorization

ApiOauth2Authorization() - Constructor for class com.carma.swagger.doclet.model.ApiOauth2Authorization

This creates a ApiOauth2Authorization

ApiOauth2Authorization(List<Oauth2Scope>, Oauth2GrantTypes) - Constructor for class com.carma.swagger.doclet.model.ApiOauth2Authorization

This creates a ApiOauth2Authorization

ApiParameter - Class in com.carma.swagger.doclet.model

The ApiParameter represents an API method parameter

ApiParameter(String, String, Boolean, Boolean, String, String, String, String, String, String, Boolean, List<String>, String, String, String) - Constructor for class com.carma.swagger.doclet.model.ApiParameter

This creates a ApiParameter

ApiResponseMessage - Class in com.carma.swagger.doclet.model

ApiResponseMessage(int, String) - Constructor for class com.carma.swagger.doclet.model.ApiResponseMessage

This creates a ApiResponseMessage with no specific response model for this error code

ApiResponseMessage(int, String, String) - Constructor for class com.carma.swagger.doclet.model.ApiResponseMessage

This creates a ApiResponseMessage with support for a custom model for this response code

B

buildApiParams(ExecutableMemberDoc, Parameter, boolean, Set<String>, Set<Model>) - Method in class com.carma.swagger.doclet.parser.ParameterReader

This builds an Api parameter from a method or constructor parameter

C

com.carma.swagger.doclet - package com.carma.swagger.doclet

com.carma.swagger.doclet.model - package com.carma.swagger.doclet.model

com.carma.swagger.doclet.parser - package com.carma.swagger.doclet.parser

com.carma.swagger.doclet.translator - package com.carma.swagger.doclet.translator

compareNumericValues(String, String, String, String, String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This verifies that the given numeric values are valid for the given data type and format and returns the comparison.

CrossClassApiParser - Class in com.carma.swagger.doclet.parser

The CrossClassApiParser represents an api class parser that supports ApiDeclaration being spread across multiple resource classes.

CrossClassApiParser(DocletOptions, ClassDoc, Collection<ClassDoc>, Map<Type, ClassDoc>, Collection<ClassDoc>, String, String, String) - Constructor for class com.carma.swagger.doclet.parser.CrossClassApiParser

This creates a CrossClassApiParser for top level parsing

CrossClassApiParser(DocletOptions, ClassDoc, Collection<ClassDoc>, Map<Type, ClassDoc>, Collection<ClassDoc>, String, String, String, Method, String) - Constructor for class com.carma.swagger.doclet.parser.CrossClassApiParser

This creates a CrossClassApiParser for parsing a subresource

D

DocletOptions - Class in com.carma.swagger.doclet

The DocletOptions represents the supported options for this doclet.

DocletOptions() - Constructor for class com.carma.swagger.doclet.DocletOptions

This creates a DocletOptions

E

element(String, String) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

This adds an element annotation to this translator, these ones are used for field and method names

equals(Object) - Method in class com.carma.swagger.doclet.model.Api

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiAuthorizations

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiBasicAuthorization

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiDeclaration

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiInfo

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiOauth2Authorization

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiParameter

equals(Object) - Method in class com.carma.swagger.doclet.model.ApiResponseMessage

equals(Object) - Method in class com.carma.swagger.doclet.model.Method

equals(Object) - Method in class com.carma.swagger.doclet.model.Model

equals(Object) - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

equals(Object) - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenEndpoint

equals(Object) - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

equals(Object) - Method in class com.carma.swagger.doclet.model.Oauth2GrantTypes

equals(Object) - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType

equals(Object) - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType.LoginEndpoint

equals(Object) - Method in class com.carma.swagger.doclet.model.Oauth2Scope

equals(Object) - Method in class com.carma.swagger.doclet.model.Operation

equals(Object) - Method in class com.carma.swagger.doclet.model.OperationAuthorizations

equals(Object) - Method in class com.carma.swagger.doclet.model.Property

equals(Object) - Method in class com.carma.swagger.doclet.model.PropertyItems

equals(Object) - Method in class com.carma.swagger.doclet.model.ResourceListing

equals(Object) - Method in class com.carma.swagger.doclet.model.ResourceListingAPI

equals(Object) - Method in class com.carma.swagger.doclet.translator.QualifiedType

equals(Object) - Method in class com.carma.swagger.doclet.translator.Translator.OptionalName

F

fieldName(FieldDoc) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

fieldName(FieldDoc) - Method in class com.carma.swagger.doclet.translator.FirstNotNullTranslator

fieldName(FieldDoc) - Method in class com.carma.swagger.doclet.translator.NameBasedTranslator

fieldName(FieldDoc) - Method in interface com.carma.swagger.doclet.translator.Translator

fieldParamNameOf(FieldDoc, Map<String, String>, List<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Determines the string representation of the parameter name.

findModel(Collection<ClassDoc>, String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This finds a model class by the given name

FirstNotNullTranslator - Class in com.carma.swagger.doclet.translator

The FirstNotNullTranslator represents a chain of translators.

FirstNotNullTranslator() - Constructor for class com.carma.swagger.doclet.translator.FirstNotNullTranslator

This creates a FirstNotNullTranslator with no links

forValue(String, NamingConvention) - Static method in enum com.carma.swagger.doclet.parser.NamingConvention

This gets a naming convention whose name matches the given string, if none matches it will return the given default value.

fromMethod(MethodDoc) - Static method in enum com.carma.swagger.doclet.model.HttpMethod

This finds a HTTP method for the given method

G

generateResourceFilename(String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This generates a file name to use for a resource with the given resource path.

getAllowableValues() - Method in class com.carma.swagger.doclet.model.Property

This gets the allowableValues

getAllowableValues(ClassDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the allowable values from an enum class doc or null if the classdoc does not represent an enum

getAllowMultiple() - Method in class com.carma.swagger.doclet.model.ApiParameter

This gets the allowMultiple

getAnnotationArrayTypes(String, String, String) - Method in class com.carma.swagger.doclet.parser.AnnotationParser

This gets a list of string values from an annotations field that is itself an array of annotations

getAnnotationClassDocValues(String, String) - Method in class com.carma.swagger.doclet.parser.AnnotationParser

This gets the values of an annotation as class docs

getAnnotationOrTagValue(ProgramElementDoc, Collection<String>, Collection<String>, DocletOptions, String...) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the first value on the given item (field or method) that matches either an annotation or a javadoc tag.

getAnnotationValue(Collection<String>, String...) - Method in class com.carma.swagger.doclet.parser.AnnotationParser

This gets the value of the first annotation with the given FQN and attribute named key

getAnnotationValue(String, String...) - Method in class com.carma.swagger.doclet.parser.AnnotationParser

This gets the value of the annotation with the given FQN and attribute named key

getAnnotationValues(String, String) - Method in class com.carma.swagger.doclet.parser.AnnotationParser

This gets the values of an annotation as strings

getApiAuthorizations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the apiAuthorizations

getApiBasePath() - Method in class com.carma.swagger.doclet.DocletOptions

getApiDescriptionTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets a list of javadoc tag names that can be used for the api description

getApiInfo() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the apiInfo

getApiKey() - Method in class com.carma.swagger.doclet.model.ApiAuthorizations

This gets the apiKey

getApis() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This gets the apis

getApis() - Method in class com.carma.swagger.doclet.model.ResourceListing

getApiVersion() - Method in class com.carma.swagger.doclet.DocletOptions

getApiVersion() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

getApiVersion() - Method in class com.carma.swagger.doclet.model.ResourceListing

getAuthOperationScopes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the authOperationScopes

getAuthOperationTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the authOperationTags

getAuthorizationCode() - Method in class com.carma.swagger.doclet.model.Oauth2GrantTypes

This gets the authorizationCode

getAuthorizations() - Method in class com.carma.swagger.doclet.model.Method

This gets the authorizations

getAuthorizations() - Method in class com.carma.swagger.doclet.model.Operation

This gets the authorizations

getAuthorizations() - Method in class com.carma.swagger.doclet.model.ResourceListing

This gets the authorizations

getBasePath() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

getBasePath() - Method in class com.carma.swagger.doclet.model.ResourceListing

getBasicAuth() - Method in class com.carma.swagger.doclet.model.ApiAuthorizations

This gets the basicAuth

getClassLevelParamNames() - Method in class com.carma.swagger.doclet.parser.ParameterReader

This gets the names of parameters in the class level @Path expression

getClientIdName() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

This gets the clientIdName

getClientSecretName() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

This gets the clientSecretName

getCode() - Method in class com.carma.swagger.doclet.model.ApiResponseMessage

This gets the code

getCompositeParamAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the compositeParamAnnotations

getCompositeParamTypes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the compositeParamTypes

getConsumes() - Method in class com.carma.swagger.doclet.model.Method

This gets the consumes

getConsumes() - Method in class com.carma.swagger.doclet.model.Operation

This gets the consumes

getConsumes(MethodDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the list of consumes mime types from the given method

getContact() - Method in class com.carma.swagger.doclet.model.ApiInfo

This gets the contact

getContainerType(Type, Map<String, Type>, Collection<ClassDoc>) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the type that a container holds

getCsvParams(ExecutableMemberDoc, Set<String>, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets a list of parameter names from a method javadoc tag where the value of the tag is in the form paramName1,paramName2 ...

getCsvParamsTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the csvParamsTags

getDefaultErrorTypeTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the defaultErrorTypeTags

getDefaultValue() - Method in class com.carma.swagger.doclet.model.Property

This gets the defaultValue

getDefaultValue(Parameter, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the default value of the given parameter

getDeprecated() - Method in class com.carma.swagger.doclet.model.Operation

This gets the deprecated

getDescription() - Method in class com.carma.swagger.doclet.model.Api

getDescription() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This gets the description of this api declaration in a resource listing

getDescription() - Method in class com.carma.swagger.doclet.model.ApiInfo

This gets the description

getDescription() - Method in class com.carma.swagger.doclet.model.Oauth2Scope

This gets the description

getDescription() - Method in class com.carma.swagger.doclet.model.Property

This gets the description of the property

getDescription() - Method in class com.carma.swagger.doclet.model.ResourceListingAPI

getDiscriminator() - Method in class com.carma.swagger.doclet.model.Model

This gets the discriminator

getDiscriminatorAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the discriminatorAnnotations

getDocBasePath() - Method in class com.carma.swagger.doclet.DocletOptions

getExcludeClassTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeClassTags

getExcludeFieldTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeFieldTags

getExcludeModelPrefixes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets prefixes of the FQN of model classes to exclude

getExcludeOperationTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeOperationTags

getExcludeParamAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeParamAnnotations

getExcludeParamsTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeParamsTags

getExcludeResourcePrefixes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets prefixes of the FQN of resource classes to exclude

getExtraApiDeclarations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the extraApiDeclarations

getFieldDefaultTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the fieldDefaultTags

getFieldDescriptionTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets list of javadoc tag names that can be used for the model field/method descriptions

getFieldFormatTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the fieldFormatTags

getFieldMaxAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getFieldMaxTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the fieldMaxTags

getFieldMinAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getFieldMinTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the fieldMinTags

getFileParameterAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the fileParameterAnnotations

getFileParameterTypes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the fileParameterTypes

getFormat() - Method in class com.carma.swagger.doclet.model.Operation

This gets the format

getFormat() - Method in class com.carma.swagger.doclet.model.Property

This gets the format

getFormat() - Method in class com.carma.swagger.doclet.model.PropertyItems

This gets the format

getFormat() - Method in class com.carma.swagger.doclet.translator.Translator.OptionalName

This gets the format

getFormParameterAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the formParameterAnnotations

getFormParameterTypes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the formParameterTypes

getGenericWrapperTypes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets a list of FQN of types which simply wrap the real underlying data type

getGrantTypes() - Method in class com.carma.swagger.doclet.model.ApiOauth2Authorization

This gets the grantTypes

getId() - Method in class com.carma.swagger.doclet.model.Model

This gets the id

getImplicit() - Method in class com.carma.swagger.doclet.model.Oauth2GrantTypes

This gets the implicit

getIncludeResourcePrefixes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets prefixes of the FQN of resource classes to include, if specified then resources must match these

getInfo() - Method in class com.carma.swagger.doclet.model.ResourceListing

This gets the info

getInheritableClassLevelAnnotationValue(ClassDoc, DocletOptions, String, String...) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets an annotation value from the given class, it supports looking at super classes

getInheritableCommentText(ExecutableMemberDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the first sentence tags of a method or its overridden ancestor method

getInheritableFirstSentenceTags(ExecutableMemberDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the first sentence tags of a method or its overridden ancestor method

getInheritableJsonViews(MethodDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the json views for the given method, it supports deriving the views from an overridden method

getInheritableTagValue(ExecutableMemberDoc, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the value of the first tag found from the given MethodDoc respecting the overriden methods

getInheritableTagValues(ExecutableMemberDoc, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets values of any of the javadoc tags that are in the given collection from the method or overridden methods

getInputTypeTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets tags that can customize the type for input body params

getItems() - Method in class com.carma.swagger.doclet.model.Operation

This gets the items

getItems() - Method in class com.carma.swagger.doclet.model.Property

This gets the items in the collection

getJsonViews(ProgramElementDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the json views for the given method/field

getKeyname() - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

This gets the keyname

getLicense() - Method in class com.carma.swagger.doclet.model.ApiInfo

This gets the license

getLicenseUrl() - Method in class com.carma.swagger.doclet.model.ApiInfo

This gets the licenseUrl

getLoginEndpoint() - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType

This gets the loginEndpoint

getMatchingParams(ExecutableMemberDoc, Set<String>, Collection<String>, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets params of the given method that have either any of the matching javadoc tags or annotations

getMaximum() - Method in class com.carma.swagger.doclet.model.Property

This gets the maximum value of the property

getMessage() - Method in class com.carma.swagger.doclet.model.ApiResponseMessage

This gets the message

getMethod() - Method in class com.carma.swagger.doclet.model.Method

getMethod() - Method in class com.carma.swagger.doclet.model.Operation

getMethodName() - Method in class com.carma.swagger.doclet.model.Method

getMethodParamNameValueLists(ExecutableMemberDoc, Set<String>, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets a map of parameter name to list of values from a javadoc tag on a method.

getMethodParamNameValuePairs(ExecutableMemberDoc, Set<String>, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets a map of parameter name to value from a javadoc tag on a method.

getMinimum() - Method in class com.carma.swagger.doclet.model.Property

This gets the minimum value of the property

getModelFieldsNamingConvention() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the modelFieldsNamingConvention

getModels() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This gets the models

getName() - Method in class com.carma.swagger.doclet.model.ApiParameter

This gets the name

getNickname() - Method in class com.carma.swagger.doclet.model.Operation

getNotes() - Method in class com.carma.swagger.doclet.model.Method

This gets the notes

getNotes() - Method in class com.carma.swagger.doclet.model.Operation

getOauth2() - Method in class com.carma.swagger.doclet.model.ApiAuthorizations

This gets the oauth2

getOauth2Scopes() - Method in class com.carma.swagger.doclet.model.OperationAuthorizations

This gets the oauth2Scopes

getOperationNotesTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets a list of javadoc tag names that can be used for the operation notes

getOperations() - Method in class com.carma.swagger.doclet.model.Api

getOperationScopeTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the operationScopeTags

getOperationSummaryTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets a list of javadoc tag names that can be used for the operation summary

getOptionalFieldAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getOptionalFields() - Method in class com.carma.swagger.doclet.model.Model

This gets the optionalFields

getOptionalFieldTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the optionalFieldTags

getOptionalParamAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getOptionalParamsTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the optionalParamsTags

getOutputDirectory() - Method in class com.carma.swagger.doclet.DocletOptions

getParamCategory() - Method in class com.carma.swagger.doclet.model.Property

This gets category of parameter of the field, only applicable to composite parameter fields

getParameterizedTypes(Type, Map<String, Type>) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets parameterized types of the given type substituting variable types if necessary

getParameterNameAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the parameterNameAnnotations

getParameters() - Method in class com.carma.swagger.doclet.model.Method

getParameters() - Method in class com.carma.swagger.doclet.model.Operation

getParameterValues(ExecutableMemberDoc, Set<String>, Collection<String>, Collection<String>, ParserHelper.TypeFilter, DocletOptions, String...) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the values of parameters from either javadoc tags or annotations

getParameterValuesWithAnnotation(ExecutableMemberDoc, Collection<String>, ParserHelper.TypeFilter, DocletOptions, String...) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the values of annotations of parameters that have any of the given annotations on them

getParameterWithAnnotations(ExecutableMemberDoc, int) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the first met parameter with annotations from the method overriding hierarchy

getParamMaxValueAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getParamMinValueAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getParamNames(ExecutableMemberDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the parameter names for the given method

getParamsAllowableValuesTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the paramsAllowableValuesTags

getParamsDefaultValueTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the paramsDefaultValueTags

getParamsFormatTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the paramsFormatTags

getParamsMaxValueTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the paramsMaxValueTags

getParamsMinValueTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the paramsMinValueTags

getParamsNameTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the paramsNameTags

getParamType() - Method in class com.carma.swagger.doclet.model.ApiParameter

This gets the paramType

getPassAs() - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

This gets the passAs

getPath() - Method in class com.carma.swagger.doclet.model.Api

getPath() - Method in class com.carma.swagger.doclet.model.Method

getPath() - Method in class com.carma.swagger.doclet.model.ResourceListingAPI

getPriority() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This gets the priority of this api declaration in a resource listing

getProduces() - Method in class com.carma.swagger.doclet.model.Method

This gets the produces

getProduces() - Method in class com.carma.swagger.doclet.model.Operation

This gets the produces

getProduces(MethodDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the list of produces mime types from the given method

getProperties() - Method in class com.carma.swagger.doclet.model.Model

This gets the properties

getQualifiedTypeName(Type) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the qualified type name of a javadoc type, It adds [] onto any array types

getQualifier() - Method in class com.carma.swagger.doclet.translator.QualifiedType

This gets the qualifier

getRawFieldName() - Method in class com.carma.swagger.doclet.model.Property

This gets the raw field name the property came from

getRecorder() - Method in class com.carma.swagger.doclet.DocletOptions

getRef() - Method in class com.carma.swagger.doclet.model.PropertyItems

This gets the ref

getRequired() - Method in class com.carma.swagger.doclet.model.ApiParameter

This gets the required

getRequiredFieldAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getRequiredFields() - Method in class com.carma.swagger.doclet.model.Model

This gets the requiredFields

getRequiredFieldTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the requiredFieldTags

getRequiredParamAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

getRequiredParamsTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the requiredParamsTags

getResourceDescriptionTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets list of javadoc tag names that can be used for the description of resources

getResourcePath() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

getResourcePriorityTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets list of javadoc tag names that can be used for ordering resources in the resource listing

getResourceRootPath() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the resourceRootPath

getResourceTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the resourceTags

getResponseMessages() - Method in class com.carma.swagger.doclet.model.Method

getResponseMessages() - Method in class com.carma.swagger.doclet.model.Operation

getResponseMessageSortMode() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the responseMessageSortMode

getResponseMessageTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the responseMessageTags

getResponseModel() - Method in class com.carma.swagger.doclet.model.ApiResponseMessage

This gets the responseModel

getResponseTypeTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the responseTypeTags

getReturnType() - Method in class com.carma.swagger.doclet.model.Method

This gets the returnType

getReturnType(DocletOptions, Type) - Static method in class com.carma.swagger.doclet.parser.ApiModelParser

This gets the return type for a resource method, it supports wrapper types

getReturnTypeFormat() - Method in class com.carma.swagger.doclet.model.Method

This gets the returnTypeFormat

getReturnTypeItemsFormat() - Method in class com.carma.swagger.doclet.model.Method

This gets the returnTypeItemsFormat

getReturnTypeItemsRef() - Method in class com.carma.swagger.doclet.model.Method

This gets the returnTypeItemsRef

getReturnTypeItemsType() - Method in class com.carma.swagger.doclet.model.Method

This gets the returnTypeItemsType

getRootModelId() - Method in class com.carma.swagger.doclet.parser.ApiModelParser

This gets the id of the root model

getRootPath() - Method in class com.carma.swagger.doclet.parser.CrossClassApiParser

This gets the root jaxrs path of the api resource class

getScope() - Method in class com.carma.swagger.doclet.model.Oauth2Scope

This gets the scope

getScopes() - Method in class com.carma.swagger.doclet.model.ApiOauth2Authorization

This gets the scopes

getStringTypePrefixes() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the stringTypePrefixes

getSubTypes() - Method in class com.carma.swagger.doclet.model.Model

This gets the subTypes

getSubTypesAnnotations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the subTypesAnnotations

getSummary() - Method in class com.carma.swagger.doclet.model.Method

This gets the summary

getSummary() - Method in class com.carma.swagger.doclet.model.Operation

getSwaggerUiPath() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the swaggerUiPath

getSwaggerVersion() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

getSwaggerVersion() - Method in class com.carma.swagger.doclet.model.ResourceListing

getTagCsvValues(ExecutableMemberDoc, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets a csv javadoc tag value as a list of the values in the csv for the first matched tag.

getTagValue(ProgramElementDoc, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets the value of the first tag found from the given collection of tag names

getTagValues(ProgramElementDoc, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets values of any of the javadoc tags that are in the given collection

getTermsOfServiceUrl() - Method in class com.carma.swagger.doclet.model.ApiInfo

This gets the termsOfServiceUrl

getTitle() - Method in class com.carma.swagger.doclet.model.ApiInfo

This gets the title

getTokenEndpoint() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

This gets the tokenEndpoint

getTokenName() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenEndpoint

This gets the tokenName

getTokenName() - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType

This gets the tokenName

getTokenRequestEndpoint() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

This gets the tokenRequestEndpoint

getTranslator() - Method in class com.carma.swagger.doclet.DocletOptions

getType() - Method in class com.carma.swagger.doclet.model.ApiBasicAuthorization

This gets the type of the authorization

getType() - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

This gets the type

getType() - Method in class com.carma.swagger.doclet.model.ApiOauth2Authorization

This gets the type of the authorization

getType() - Method in class com.carma.swagger.doclet.model.Operation

getType() - Method in class com.carma.swagger.doclet.model.Property

This gets the type of property

getType() - Method in class com.carma.swagger.doclet.model.PropertyItems

This gets the type

getType() - Method in class com.carma.swagger.doclet.translator.QualifiedType

This gets the type

getUnauthOperationTags() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the unauthOperationTags

getUnauthOperationTagValues() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the unauthOperationTagValues

getUniqueItems() - Method in class com.carma.swagger.doclet.model.Property

This gets the uniqueItems

getUrl() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenEndpoint

This gets the url

getUrl() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

This gets the url

getUrl() - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType.LoginEndpoint

This gets the url

getVarType(TypeVariable, Map<String, Type>) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This finds a variable type and returns its impl from the given map

H

hasAncestor(ClassDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether a class doc has an ancestor class that can be processed, e.g.

hasAnnotation(ProgramElementDoc, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given item has one of the given annotations

hasAnnotation(Parameter, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given parameter has one of the given annotations

hasAnnotationWithPrefix(Parameter, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given parameter has an annotation whose FQN begins with one of the given prefixes

hashCode() - Method in class com.carma.swagger.doclet.model.Api

hashCode() - Method in class com.carma.swagger.doclet.model.ApiAuthorizations

hashCode() - Method in class com.carma.swagger.doclet.model.ApiBasicAuthorization

hashCode() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

hashCode() - Method in class com.carma.swagger.doclet.model.ApiInfo

hashCode() - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

hashCode() - Method in class com.carma.swagger.doclet.model.ApiOauth2Authorization

hashCode() - Method in class com.carma.swagger.doclet.model.ApiParameter

hashCode() - Method in class com.carma.swagger.doclet.model.ApiResponseMessage

hashCode() - Method in class com.carma.swagger.doclet.model.Method

hashCode() - Method in class com.carma.swagger.doclet.model.Model

hashCode() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

hashCode() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenEndpoint

hashCode() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

hashCode() - Method in class com.carma.swagger.doclet.model.Oauth2GrantTypes

hashCode() - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType

hashCode() - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType.LoginEndpoint

hashCode() - Method in class com.carma.swagger.doclet.model.Oauth2Scope

hashCode() - Method in class com.carma.swagger.doclet.model.Operation

hashCode() - Method in class com.carma.swagger.doclet.model.OperationAuthorizations

hashCode() - Method in class com.carma.swagger.doclet.model.Property

hashCode() - Method in class com.carma.swagger.doclet.model.PropertyItems

hashCode() - Method in class com.carma.swagger.doclet.model.ResourceListing

hashCode() - Method in class com.carma.swagger.doclet.model.ResourceListingAPI

hashCode() - Method in class com.carma.swagger.doclet.translator.QualifiedType

hashCode() - Method in class com.carma.swagger.doclet.translator.Translator.OptionalName

hasInheritableAnnotation(MethodDoc, Collection<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given method or an overridden method has any of the given annotations

hasInheritableTag(ExecutableMemberDoc, Collection<String>) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given method or an overridden method has any of the given tags

hasJaxRsAnnotation(Parameter, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given parameter has a JAXRS annotation

hasJsonViews(ProgramElementDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given method/field has a json view on it

hasTag(ProgramElementDoc, Collection<String>) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given item has any of the given tags

HttpMethod - Enum in com.carma.swagger.doclet.model

I

ignore(String) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

This adds an ignore annotation to this translator

ignored() - Static method in class com.carma.swagger.doclet.translator.Translator.OptionalName

isAnnotatedBy(String) - Method in class com.carma.swagger.doclet.parser.AnnotationParser

This gets whether this is annotated by the given annotation

isAnnotatedByPrefix(String) - Method in class com.carma.swagger.doclet.parser.AnnotationParser

This gets whether this is annotated by an annotation that starts with the given prefix

isArray(Type) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is an Array

isArray(String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is an Array

isAssignableFrom(ClassDoc[], ClassDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This checks if the given clazz is the same as or implments or is a subclass/sub interface of any of the given classes

isCollection(String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is a Collection

isDeprecated() - Method in class com.carma.swagger.doclet.model.Method

This gets the deprecated

isDeprecated(ProgramElementDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation

isDeprecated(Parameter, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given parameter is marked as deprecated either via a javadoc tag or an annotation

isExcludeDeprecatedFields() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeDeprecatedFields

isExcludeDeprecatedModelClasses() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeDeprecatedModelClasses

isExcludeDeprecatedOperations() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeDeprecatedOperations

isExcludeDeprecatedParams() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeDeprecatedParams

isExcludeDeprecatedResourceClasses() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the excludeDeprecatedResourceClasses

isFileParameterDataType(Parameter, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given parameter is a File data type

isIncludeSwaggerUi() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the includeSwaggerUi

isInheritableDeprecated(MethodDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given item is marked as deprecated either via a javadoc tag or an annotation, this supports looking at overridden methods

isItemPartOfView(ClassDoc[], ClassDoc[]) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This checks if an item view e.g optional json view that can be on a getter/field match any of the given operation views, that is it can be the same or extend/implement one of the operation views.

isMap(String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is a Map

isMissing() - Method in class com.carma.swagger.doclet.translator.Translator.OptionalName

isModelFieldsDefaultXmlAccessTypeEnabled() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the modelFieldsDefaultXmlAccessTypeEnabled

isModelFieldsRequiredByDefault() - Method in class com.carma.swagger.doclet.DocletOptions

This is whether model fields are required by default e.g.

isModelFieldsXmlAccessTypeEnabled() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the modelFieldsXmlAccessTypeEnabled

isNumber(Type, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is primitive

isParseModels() - Method in class com.carma.swagger.doclet.DocletOptions

This is whether model parsing is enabled

isPresent() - Method in class com.carma.swagger.doclet.translator.Translator.OptionalName

isPrimitive(String, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is primitive

isPrimitive(Type, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is primitive

isSet(String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets whether the given type is a Set

isSortApisByPath() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the sortOperationsByPath

isSortResourcesByPath() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the sortResourcesByPath

isSortResourcesByPriority() - Method in class com.carma.swagger.doclet.DocletOptions

This gets the sortResourcesByPriority

isSubResource() - Method in class com.carma.swagger.doclet.model.Method

J

JAXRS_PARAM_ANNOTATIONS - Static variable in class com.carma.swagger.doclet.parser.ParserHelper

This is a set of the FQN of the various JAXRS parameter annotations

JaxRsAnnotationParser - Class in com.carma.swagger.doclet.parser

JaxRsAnnotationParser(DocletOptions, RootDoc) - Constructor for class com.carma.swagger.doclet.parser.JaxRsAnnotationParser

L

languageVersion() - Static method in class com.carma.swagger.doclet.ServiceDoclet

Return the version of the Java Programming Language supported by this doclet.

listInheritableValues(ExecutableMemberDoc, String, String, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets a list of values from an annotation that uses a string array value, it supports getting it from a superclass method

listValues(ProgramElementDoc, String, String, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This gets a list of values from an annotation that uses a string array value

lookUpClassDoc(Type, Collection<ClassDoc>) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This looks up a class doc with the given type from the given collection of classes

M

matches(Type) - Method in class com.carma.swagger.doclet.parser.ParserHelper.NumericTypeFilter

matches(Type) - Method in interface com.carma.swagger.doclet.parser.ParserHelper.TypeFilter

merge(Collection<ApiDeclaration>) - Method in class com.carma.swagger.doclet.parser.ApiDeclarationMerger

This merges the declarations in the given collection together as needed

Method - Class in com.carma.swagger.doclet.model

Method(HttpMethod, String, String, List<ApiParameter>, List<ApiResponseMessage>, String, String, String, String, String, String, String, List<String>, List<String>, OperationAuthorizations, boolean) - Constructor for class com.carma.swagger.doclet.model.Method

methodName(MethodDoc) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

methodName(MethodDoc) - Method in class com.carma.swagger.doclet.translator.FirstNotNullTranslator

methodName(MethodDoc) - Method in class com.carma.swagger.doclet.translator.NameBasedTranslator

methodName(MethodDoc) - Method in interface com.carma.swagger.doclet.translator.Translator

Model - Class in com.carma.swagger.doclet.model

The Model represents a description of an input or output entity or sub entity.

Model() - Constructor for class com.carma.swagger.doclet.model.Model

This creates a Model

Model(String, Map<String, Property>, List<String>, List<String>, List<String>, String) - Constructor for class com.carma.swagger.doclet.model.Model

This creates a Model

models() - Method in class com.carma.swagger.doclet.parser.ApiMethodParser

This gets the parsed models found for this method

N

NameBasedTranslator - Class in com.carma.swagger.doclet.translator

The NameBasedTranslator represents a translator that looks up names of items based on their javadoc signature

NameBasedTranslator(DocletOptions) - Constructor for class com.carma.swagger.doclet.translator.NameBasedTranslator

This creates a NameBasedTranslator

NamingConvention - Enum in com.carma.swagger.doclet.parser

The NamingConvention represents naming conventions for how items such as fields should be named

O

Oauth2AuthorizationCodeGrantType - Class in com.carma.swagger.doclet.model

The Oauth2AuthorizationCodeGrantType represents

Oauth2AuthorizationCodeGrantType() - Constructor for class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

This creates a Oauth2AuthorizationCodeGrantType

Oauth2AuthorizationCodeGrantType(Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint, Oauth2AuthorizationCodeGrantType.TokenEndpoint) - Constructor for class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

This creates a Oauth2AuthorizationCodeGrantType

Oauth2AuthorizationCodeGrantType(String, String) - Constructor for class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

This creates a Oauth2AuthorizationCodeGrantType with the given endpoint urls

Oauth2AuthorizationCodeGrantType.TokenEndpoint - Class in com.carma.swagger.doclet.model

The TokenEndpoint represents the token endpoint

Oauth2AuthorizationCodeGrantType.TokenEndpoint() - Constructor for class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenEndpoint

This creates a TokenEndpoint

Oauth2AuthorizationCodeGrantType.TokenEndpoint(String) - Constructor for class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenEndpoint

This creates a TokenEndpoint

Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint - Class in com.carma.swagger.doclet.model

The TokenRequestEndpoint represents the url for the request token endpoint

Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint() - Constructor for class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

This creates a TokenRequestEndpoint

Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint(String) - Constructor for class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

This creates a TokenRequestEndpoint

Oauth2GrantTypes - Class in com.carma.swagger.doclet.model

The Oauth2GrantTypes represents different oauth2 grant types

Oauth2GrantTypes() - Constructor for class com.carma.swagger.doclet.model.Oauth2GrantTypes

This creates a Oauth2GrantTypes

Oauth2GrantTypes(Oauth2AuthorizationCodeGrantType) - Constructor for class com.carma.swagger.doclet.model.Oauth2GrantTypes

This creates a Oauth2GrantTypes

Oauth2GrantTypes(Oauth2ImplicitGrantType) - Constructor for class com.carma.swagger.doclet.model.Oauth2GrantTypes

This creates a Oauth2GrantTypes

Oauth2GrantTypes(Oauth2AuthorizationCodeGrantType, Oauth2ImplicitGrantType) - Constructor for class com.carma.swagger.doclet.model.Oauth2GrantTypes

This creates a Oauth2GrantTypes

Oauth2ImplicitGrantType - Class in com.carma.swagger.doclet.model

The Oauth2ImplicitGrantType represents the definition of the implicit flow

Oauth2ImplicitGrantType() - Constructor for class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType

This creates a Oauth2ImplicitGrantType

Oauth2ImplicitGrantType(String) - Constructor for class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType

This creates a Oauth2ImplicitGrantType

Oauth2ImplicitGrantType.LoginEndpoint - Class in com.carma.swagger.doclet.model

The LoginEndpoint represents the login endpoint used for the implicit flow

Oauth2ImplicitGrantType.LoginEndpoint() - Constructor for class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType.LoginEndpoint

This creates a LoginEndpoint

Oauth2ImplicitGrantType.LoginEndpoint(String) - Constructor for class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType.LoginEndpoint

This creates a LoginEndpoint

Oauth2Scope - Class in com.carma.swagger.doclet.model

The Oauth2Scope represents an oauth2 scope

Oauth2Scope() - Constructor for class com.carma.swagger.doclet.model.Oauth2Scope

This creates a Oauth2Scope

Oauth2Scope(String, String) - Constructor for class com.carma.swagger.doclet.model.Oauth2Scope

This creates a Oauth2Scope

ObjectMapperRecorder - Class in com.carma.swagger.doclet

The ObjectMapperRecorder represents a mapper for writing swagger objects to files

ObjectMapperRecorder(String, String, String, String) - Constructor for class com.carma.swagger.doclet.ObjectMapperRecorder

This creates a ObjectMapperRecorder

Operation - Class in com.carma.swagger.doclet.model

Operation(Method) - Constructor for class com.carma.swagger.doclet.model.Operation

OperationAuthorizations - Class in com.carma.swagger.doclet.model

The OperationAuthorizations represents the authorizations element for the API

OperationAuthorizations() - Constructor for class com.carma.swagger.doclet.model.OperationAuthorizations

This creates a OperationAuthorizations

OperationAuthorizations(List<Oauth2Scope>) - Constructor for class com.carma.swagger.doclet.model.OperationAuthorizations

This creates a OperationAuthorizations

optionLength(String) - Static method in class com.carma.swagger.doclet.ServiceDoclet

Check for doclet-added options.

P

ParameterReader - Class in com.carma.swagger.doclet.parser

The ParameterReader represents a utility class that supports reading api parameters

ParameterReader(DocletOptions, Collection<ClassDoc>) - Constructor for class com.carma.swagger.doclet.parser.ParameterReader

This creates a PathParameterReader

parameterTypeName(boolean, Parameter, Type) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

parameterTypeName(boolean, Parameter, Type) - Method in class com.carma.swagger.doclet.translator.FirstNotNullTranslator

parameterTypeName(boolean, Parameter, Type) - Method in class com.carma.swagger.doclet.translator.NameBasedTranslator

parameterTypeName(boolean, Parameter, Type) - Method in interface com.carma.swagger.doclet.translator.Translator

paramNameOf(Parameter, Map<String, String>, List<String>, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Determines the string representation of the parameter name.

paramTypeOf(boolean, boolean, ProgramElementDoc, Type, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Determines the string representation of the parameter type for composite types.

paramTypeOf(boolean, Parameter, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Determines the string representation of the parameter type.

parse(String[][]) - Static method in class com.carma.swagger.doclet.DocletOptions

This parses doclet options

parse() - Method in class com.carma.swagger.doclet.parser.ApiMethodParser

This parses a javadoc method doc and builds a pojo representation of it.

parse() - Method in class com.carma.swagger.doclet.parser.ApiModelParser

This parsers a model class built from parsing this class

parse(Map<String, ApiDeclaration>) - Method in class com.carma.swagger.doclet.parser.CrossClassApiParser

This parses the api declarations from the resource classes of the api

parsePath(ProgramElementDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This parses the path from the annotations of a method or class

ParserHelper - Class in com.carma.swagger.doclet.parser

The ParserHelper represents a helper class for the parsers

ParserHelper() - Constructor for class com.carma.swagger.doclet.parser.ParserHelper

ParserHelper.NumericTypeFilter - Class in com.carma.swagger.doclet.parser

ParserHelper.NumericTypeFilter(DocletOptions) - Constructor for class com.carma.swagger.doclet.parser.ParserHelper.NumericTypeFilter

ParserHelper.TypeFilter - Interface in com.carma.swagger.doclet.parser

presentOrMissing(String) - Static method in class com.carma.swagger.doclet.translator.Translator.OptionalName

presentOrMissing(String, String) - Static method in class com.carma.swagger.doclet.translator.Translator.OptionalName

Property - Class in com.carma.swagger.doclet.model

The Property represents a model property

Property(String, String, String, String, String, String, String, String, Boolean, List<String>, String, String, String) - Constructor for class com.carma.swagger.doclet.model.Property

This creates a Property

PropertyItems - Class in com.carma.swagger.doclet.model

The PropertyItemsObject represents an object that defines the items for a collections

PropertyItems() - Constructor for class com.carma.swagger.doclet.model.PropertyItems

This creates a PropertyItems

PropertyItems(String, String, String) - Constructor for class com.carma.swagger.doclet.model.PropertyItems

This creates a PropertyItems

Q

QualifiedType - Class in com.carma.swagger.doclet.translator

The QualifiedType represents a type with a qualifier.

QualifiedType(String, Type) - Constructor for class com.carma.swagger.doclet.translator.QualifiedType

This creates a QualifiedType

QualifiedType(Type) - Constructor for class com.carma.swagger.doclet.translator.QualifiedType

This creates a QualifiedType

R

readClass(ClassDoc) - Method in class com.carma.swagger.doclet.parser.ParameterReader

This reads a class storing any path parameters from the class level

readClassLevelParameters(Set<Model>) - Method in class com.carma.swagger.doclet.parser.ParameterReader

This reads a list of class parameters.

readSeeTypes(ProgramElementDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This builds a map of FQN to type for all see annotations on the given items javadoc

record(File, ApiDeclaration) - Method in class com.carma.swagger.doclet.ObjectMapperRecorder

record(File, ResourceListing) - Method in class com.carma.swagger.doclet.ObjectMapperRecorder

record(File, ResourceListing) - Method in interface com.carma.swagger.doclet.Recorder

record(File, ApiDeclaration) - Method in interface com.carma.swagger.doclet.Recorder

Recorder - Interface in com.carma.swagger.doclet

replaceVariables(Properties, String) - Static method in class com.carma.swagger.doclet.parser.VariableReplacer

This does a replacement of variable references in the given value where references should be in the form ${propertyname}.

replaceVars(String) - Method in class com.carma.swagger.doclet.DocletOptions

This replaces any variables in the given value with replacements defined in the doclets variable replacements file

resolveMethodHttpMethod(MethodDoc) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Resolves HttpMethod for the MethodDoc respecting the overriden methods

resolveMethodPath(MethodDoc, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Resolves tha @Path for the MethodDoc respecting the overriden methods

ResourceListing - Class in com.carma.swagger.doclet.model

ResourceListing(String, String, String, List<ResourceListingAPI>, ApiAuthorizations, ApiInfo) - Constructor for class com.carma.swagger.doclet.model.ResourceListing

ResourceListingAPI - Class in com.carma.swagger.doclet.model

ResourceListingAPI(String, String) - Constructor for class com.carma.swagger.doclet.model.ResourceListingAPI

ResponseMessageSortMode - Enum in com.carma.swagger.doclet.parser

The ResponseMessageSortMode represents the sort mode for response messages

rootElement(String, String) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

This adds an root annotation to this translator, these ones are used for class type names

run() - Method in class com.carma.swagger.doclet.parser.JaxRsAnnotationParser

S

sanitizePath(String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This sanitizes an API path.

ServiceDoclet - Class in com.carma.swagger.doclet

ServiceDoclet() - Constructor for class com.carma.swagger.doclet.ServiceDoclet

setAllowMultiple(Boolean) - Method in class com.carma.swagger.doclet.model.ApiParameter

This sets the allowMultiple

setApiAuthorizations(ApiAuthorizations) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the apiAuthorizations

setApiBasePath(String) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the apiBasePath

setApiInfo(ApiInfo) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the apiInfo

setApis(List<Api>) - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This sets the apis

setApiVersion(String) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the apiVersion

setDescription(String) - Method in class com.carma.swagger.doclet.model.Api

This sets the description

setDescription(String) - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This sets the description

setDiscriminator(String) - Method in class com.carma.swagger.doclet.model.Model

This sets the discriminator

setDocBasePath(String) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the docBasePath

setExcludeDeprecatedFields(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the excludeDeprecatedFields

setExcludeDeprecatedOperations(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the excludeDeprecatedOperations

setExcludeDeprecatedParams(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the excludeDeprecatedParams

setExcludeModelPrefixes(List<String>) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the prefixes of the FQN of model classes to exclude

setExcludeResourcePrefixes(List<String>) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the prefixes of the FQN of resource classes to exclude

setExtraApiDeclarations(List<ApiDeclaration>) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the extraApiDeclarations

setId(String) - Method in class com.carma.swagger.doclet.model.Model

This sets the id

setIncludeResourcePrefixes(List<String>) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the prefixes of the FQN of resource classes to include, if specified then resources must match these

setIncludeSwaggerUi(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the includeSwaggerUi

setKeyname(String) - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

This sets the keyname

setModelFieldsDefaultXmlAccessTypeEnabled(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the modelFieldsDefaultXmlAccessTypeEnabled

setModelFieldsNamingConvention(NamingConvention) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the modelFieldsNamingConvention

setModelFieldsRequiredByDefault(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the modelFieldsRequiredByDefault

setModelFieldsXmlAccessTypeEnabled(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the modelFieldsXmlAccessTypeEnabled

setModels(Map<String, Model>) - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This sets the models

setName(String) - Method in class com.carma.swagger.doclet.model.ApiParameter

This sets the name

setOptionalFields(List<String>) - Method in class com.carma.swagger.doclet.model.Model

This sets the optionalFields

setParamType(String) - Method in class com.carma.swagger.doclet.model.ApiParameter

This sets the paramType

setPassAs(String) - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

This sets the passAs

setPriority(int) - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This sets the priority

setProperties(Map<String, Property>) - Method in class com.carma.swagger.doclet.model.Model

This sets the properties

setRecorder(Recorder) - Method in class com.carma.swagger.doclet.DocletOptions

setRequired(Boolean) - Method in class com.carma.swagger.doclet.model.ApiParameter

This sets the required

setRequiredFields(List<String>) - Method in class com.carma.swagger.doclet.model.Model

This sets the requiredFields

setResourcePath(String) - Method in class com.carma.swagger.doclet.model.ApiDeclaration

This sets the resourcePath

setResourceRootPath(String) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the resourceRootPath

setResponseMessageSortMode(ResponseMessageSortMode) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the responseMessageSortMode

setSortApisByPath(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the sortApisByPath

setSortResourcesByPath(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the sortResourcesByPath

setSortResourcesByPriority(boolean) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the sortResourcesByPriority

setSubTypes(List<String>) - Method in class com.carma.swagger.doclet.model.Model

This sets the subTypes

setTranslator(Translator) - Method in class com.carma.swagger.doclet.DocletOptions

setVariableReplacements(Properties) - Method in class com.carma.swagger.doclet.DocletOptions

This sets the variable replacements to use

start(RootDoc) - Static method in class com.carma.swagger.doclet.ServiceDoclet

Generate documentation here.

T

toLowerUnderscore(String) - Static method in enum com.carma.swagger.doclet.parser.NamingConvention

This converts a camel case type value into lower underscore form

toString() - Method in class com.carma.swagger.doclet.model.Api

toString() - Method in class com.carma.swagger.doclet.model.ApiAuthorizations

toString() - Method in class com.carma.swagger.doclet.model.ApiBasicAuthorization

toString() - Method in class com.carma.swagger.doclet.model.ApiDeclaration

toString() - Method in class com.carma.swagger.doclet.model.ApiInfo

toString() - Method in class com.carma.swagger.doclet.model.ApiKeyAuthorization

toString() - Method in class com.carma.swagger.doclet.model.ApiOauth2Authorization

toString() - Method in class com.carma.swagger.doclet.model.ApiParameter

toString() - Method in class com.carma.swagger.doclet.model.ApiResponseMessage

toString() - Method in class com.carma.swagger.doclet.model.Method

toString() - Method in class com.carma.swagger.doclet.model.Model

toString() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenEndpoint

toString() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType.TokenRequestEndpoint

toString() - Method in class com.carma.swagger.doclet.model.Oauth2AuthorizationCodeGrantType

toString() - Method in class com.carma.swagger.doclet.model.Oauth2GrantTypes

toString() - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType.LoginEndpoint

toString() - Method in class com.carma.swagger.doclet.model.Oauth2ImplicitGrantType

toString() - Method in class com.carma.swagger.doclet.model.Oauth2Scope

toString() - Method in class com.carma.swagger.doclet.model.Operation

toString() - Method in class com.carma.swagger.doclet.model.OperationAuthorizations

toString() - Method in class com.carma.swagger.doclet.model.Property

toString() - Method in class com.carma.swagger.doclet.model.PropertyItems

toString() - Method in class com.carma.swagger.doclet.model.ResourceListing

toString() - Method in class com.carma.swagger.doclet.model.ResourceListingAPI

toString() - Method in class com.carma.swagger.doclet.translator.Translator.OptionalName

Translator - Interface in com.carma.swagger.doclet.translator

Translator.OptionalName - Class in com.carma.swagger.doclet.translator

trimLeadingChars(String, char...) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This trims specific characters from the start of the given string

typeName(Type, ClassDoc[]) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

typeName(Type) - Method in class com.carma.swagger.doclet.translator.AnnotationAwareTranslator

typeName(Type, ClassDoc[]) - Method in class com.carma.swagger.doclet.translator.FirstNotNullTranslator

typeName(Type) - Method in class com.carma.swagger.doclet.translator.FirstNotNullTranslator

typeName(Type, ClassDoc[]) - Method in class com.carma.swagger.doclet.translator.NameBasedTranslator

typeName(Type) - Method in class com.carma.swagger.doclet.translator.NameBasedTranslator

typeName(Type, ClassDoc[]) - Method in interface com.carma.swagger.doclet.translator.Translator

typeName(Type) - Method in interface com.carma.swagger.doclet.translator.Translator

typeOf(String, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Determines the String representation of the given FQN.

typeOf(Type, DocletOptions) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

Determines the String representation of the object Type.

V

value() - Method in class com.carma.swagger.doclet.translator.Translator.OptionalName

valueOf(String) - Static method in enum com.carma.swagger.doclet.model.HttpMethod

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.carma.swagger.doclet.parser.NamingConvention

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.carma.swagger.doclet.parser.ResponseMessageSortMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.carma.swagger.doclet.model.HttpMethod

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.carma.swagger.doclet.parser.NamingConvention

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.carma.swagger.doclet.parser.ResponseMessageSortMode

Returns an array containing the constants of this enum type, in the order they are declared.

VariableReplacer - Class in com.carma.swagger.doclet.parser

The VariableReplacer represents a util class for replacing variable references in text with variable values from a properties file

VariableReplacer() - Constructor for class com.carma.swagger.doclet.parser.VariableReplacer

verifyNumericValue(String, String, String, String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This verifies that the given value is valid for the given data type and format for use as a numeric value which means it must be integer or number type.

verifyValue(String, String, String, String) - Static method in class com.carma.swagger.doclet.parser.ParserHelper

This verifies that the given value is valid for the given data type and format.

A B C D E F G H I J L M N O P Q R S T V