Skip navigation links
A B C D E G H I J L M O R S T U V 

A

AbstractDoc - Class in org.jsondoc.core.pojo
 
AbstractDoc() - Constructor for class org.jsondoc.core.pojo.AbstractDoc
 
AbstractJSONDocScanner - Class in org.jsondoc.core.scanner
 
AbstractJSONDocScanner() - Constructor for class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
addItemToType(String) - Method in class org.jsondoc.core.util.JSONDocType
 
addJsondocerror(String) - Method in class org.jsondoc.core.pojo.AbstractDoc
 
addJsondochint(String) - Method in class org.jsondoc.core.pojo.AbstractDoc
 
addJsondocwarning(String) - Method in class org.jsondoc.core.pojo.AbstractDoc
 
addMethod(ApiMethodDoc) - Method in class org.jsondoc.core.pojo.ApiDoc
 
addMethod(ApiMethodDoc) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
addPrecondition(String) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
addStep(ApiFlowStepDoc) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
addTestUser(String, String) - Method in class org.jsondoc.core.pojo.ApiAuthDoc
 
allApiMethodDocs - Variable in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
ANONYMOUS - Static variable in class org.jsondoc.core.scanner.DefaultJSONDocScanner
 
Api - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your "service" class, for example controller classes in Spring MVC.
ApiAuthBasic - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your "service" class, for example controllers, or on exposed methods.
ApiAuthBasicUser - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used inside an annotation of type ApiAuthBasic.
ApiAuthDoc - Class in org.jsondoc.core.pojo
 
ApiAuthDoc() - Constructor for class org.jsondoc.core.pojo.ApiAuthDoc
 
ApiAuthNone - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your "service" class, for example controllers, or on exposed methods.
ApiAuthType - Enum in org.jsondoc.core.pojo
 
ApiBodyObject - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your method and represents the body object passed the request.
ApiBodyObjectDoc - Class in org.jsondoc.core.pojo
 
ApiBodyObjectDoc(JSONDocType) - Constructor for class org.jsondoc.core.pojo.ApiBodyObjectDoc
 
ApiDoc - Class in org.jsondoc.core.pojo
 
ApiDoc() - Constructor for class org.jsondoc.core.pojo.ApiDoc
 
ApiError - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used inside an annotation of type ApiErrors
ApiErrorDoc - Class in org.jsondoc.core.pojo
 
ApiErrorDoc(String, String) - Constructor for class org.jsondoc.core.pojo.ApiErrorDoc
 
ApiErrors - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your method and represents the possible errors returned by the method
ApiFlow - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on a method (typically on a class dedicated to flow description) and contains an array of ApiFlowStep
ApiFlowDoc - Class in org.jsondoc.core.pojo
 
ApiFlowDoc() - Constructor for class org.jsondoc.core.pojo.ApiFlowDoc
 
ApiFlowSet - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on a type (typically on a class dedicated to flow description) and will trigger scanning for @ApiFlow annotations
ApiFlowStep - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used inside an annotaion of type @ApiFlow and references a method previously documented with the JSONDoc @ApiMethod annotation in which the "id" property is specified
ApiFlowStepDoc - Class in org.jsondoc.core.pojo
 
ApiFlowStepDoc() - Constructor for class org.jsondoc.core.pojo.ApiFlowStepDoc
 
ApiHeader - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used inside an annotation of type ApiHeaders
ApiHeaderDoc - Class in org.jsondoc.core.pojo
 
ApiHeaderDoc(String, String, String[]) - Constructor for class org.jsondoc.core.pojo.ApiHeaderDoc
 
ApiHeaders - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your method and contains an array of ApiHeader
ApiMethod - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your exposed methods.
ApiMethodDoc - Class in org.jsondoc.core.pojo
 
ApiMethodDoc() - Constructor for class org.jsondoc.core.pojo.ApiMethodDoc
 
ApiObject - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your object classes and represents an object used for communication between clients and server
ApiObjectDoc - Class in org.jsondoc.core.pojo
 
ApiObjectDoc() - Constructor for class org.jsondoc.core.pojo.ApiObjectDoc
 
ApiObjectField - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your objects' fields and represents a field of an object
ApiObjectFieldDoc - Class in org.jsondoc.core.pojo
 
ApiObjectFieldDoc() - Constructor for class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
ApiParamDoc - Class in org.jsondoc.core.pojo
 
ApiParamDoc(String, String, JSONDocType, String, String[], String, String) - Constructor for class org.jsondoc.core.pojo.ApiParamDoc
 
ApiParams - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your method and contains an array of ApiParam
ApiParamType - Enum in org.jsondoc.core.pojo
 
ApiPathParam - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used inside an annotation of type ApiParams
ApiQueryParam - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used inside an annotation of type ApiParams
ApiResponseObject - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your method and represents the returned value
ApiResponseObjectDoc - Class in org.jsondoc.core.pojo
 
ApiResponseObjectDoc(JSONDocType) - Constructor for class org.jsondoc.core.pojo.ApiResponseObjectDoc
 
ApiVerb - Enum in org.jsondoc.core.pojo
 
ApiVersion - Annotation Type in org.jsondoc.core.annotation
This annotation is to be used on your "service" class, for example controller classes in Spring MVC.
ApiVersionDoc - Class in org.jsondoc.core.pojo
 
ApiVersionDoc() - Constructor for class org.jsondoc.core.pojo.ApiVersionDoc
 

B

build(Method) - Static method in class org.jsondoc.core.pojo.ApiBodyObjectDoc
 
build(Method) - Static method in class org.jsondoc.core.pojo.ApiErrorDoc
 
build(Method) - Static method in class org.jsondoc.core.pojo.ApiHeaderDoc
 
build(Method) - Static method in class org.jsondoc.core.pojo.ApiResponseObjectDoc
 
build(Class<?>) - Static method in class org.jsondoc.core.pojo.ApiVersionDoc
 
build(Method) - Static method in class org.jsondoc.core.pojo.ApiVersionDoc
 
build(Field) - Static method in class org.jsondoc.core.pojo.ApiVersionDoc
 
build(Class<?>) - Static method in class org.jsondoc.core.util.JSONDocTemplateBuilder
 
build(JSONDocType, Class<?>, Type) - Static method in class org.jsondoc.core.util.JSONDocTypeBuilder
 
buildFromAnnotation(Api) - Static method in class org.jsondoc.core.pojo.ApiDoc
 
buildFromAnnotation(ApiFlow, List<ApiMethodDoc>) - Static method in class org.jsondoc.core.pojo.ApiFlowDoc
 
buildFromAnnotation(ApiFlowStep, List<ApiMethodDoc>) - Static method in class org.jsondoc.core.pojo.ApiFlowStepDoc
 
buildFromAnnotation(ApiMethod) - Static method in class org.jsondoc.core.pojo.ApiMethodDoc
 
buildFromAnnotation(ApiObject, Class) - Static method in class org.jsondoc.core.pojo.ApiObjectDoc
 
buildFromAnnotation(ApiObjectField, Field) - Static method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
buildFromAnnotation(ApiPathParam, JSONDocType, ApiParamType) - Static method in class org.jsondoc.core.pojo.ApiParamDoc
 
buildFromAnnotation(ApiQueryParam, JSONDocType, ApiParamType) - Static method in class org.jsondoc.core.pojo.ApiParamDoc
 
buildFromApiAuthBasicAnnotation(ApiAuthBasic) - Static method in class org.jsondoc.core.pojo.ApiAuthDoc
 
buildFromApiAuthNoneAnnotation(ApiAuthNone) - Static method in class org.jsondoc.core.pojo.ApiAuthDoc
 
buildFromUndefined() - Static method in class org.jsondoc.core.pojo.ApiAuthDoc
 

C

compareTo(ApiDoc) - Method in class org.jsondoc.core.pojo.ApiDoc
 
compareTo(ApiFlowDoc) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
compareTo(ApiMethodDoc) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
compareTo(ApiObjectDoc) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
compareTo(ApiObjectFieldDoc) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
This comparison is the same as the one in ApiObjectFieldDoc class
compareTo(ApiParamDoc) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
compareTo(JSONDocFieldWrapper) - Method in class org.jsondoc.core.util.JSONDocFieldWrapper
This comparison is the same as the one in ApiObjectFieldDoc class

D

DefaultJSONDocScanner - Class in org.jsondoc.core.scanner
 
DefaultJSONDocScanner() - Constructor for class org.jsondoc.core.scanner.DefaultJSONDocScanner
 

E

enumConstantsToStringArray(Object[]) - Static method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
equals(Object) - Method in class org.jsondoc.core.pojo.ApiHeaderDoc
 
equals(Object) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
equals(Object) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 

G

getAllowedvalues() - Method in class org.jsondoc.core.pojo.ApiHeaderDoc
 
getAllowedvalues() - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
getAllowedvalues() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getAllowedvalues() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
getApiAuthDocForController(Class<?>) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApiAuthDocForMethod(Method, Class<?>) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApiDocs(Set<Class<?>>, JSONDoc.MethodDisplay) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
Gets the API documentation for the set of classes passed as argument
getApiDocs(Set<Class<?>>, JSONDoc.MethodDisplay) - Method in interface org.jsondoc.core.scanner.JSONDocScanner
 
getApiDocsMap(Set<Class<?>>, JSONDoc.MethodDisplay) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApierrors() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getApiFlowDocs(Set<Class<?>>, List<ApiMethodDoc>) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
Gets the API flow documentation for the set of classes passed as argument
getApiFlowDocs(Set<Class<?>>, List<ApiMethodDoc>) - Method in interface org.jsondoc.core.scanner.JSONDocScanner
 
getApiFlowDocsMap(Set<Class<?>>, List<ApiMethodDoc>) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApimethoddoc() - Method in class org.jsondoc.core.pojo.ApiFlowStepDoc
 
getApimethodid() - Method in class org.jsondoc.core.pojo.ApiFlowStepDoc
 
getApiObjectDocs(Set<Class<?>>) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApiObjectDocs(Set<Class<?>>) - Method in interface org.jsondoc.core.scanner.JSONDocScanner
 
getApiObjectsMap(Set<Class<?>>) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApiPathParamDocs(Method) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApiQueryParamDocs(Method) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
getApis() - Method in class org.jsondoc.core.pojo.JSONDoc
 
getAuth() - Method in class org.jsondoc.core.pojo.ApiDoc
 
getAuth() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getBasePath() - Method in class org.jsondoc.core.pojo.JSONDoc
 
getBodyobject() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getCode() - Method in class org.jsondoc.core.pojo.ApiErrorDoc
 
getConsumes() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getDefaultvalue() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiErrorDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiHeaderDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getDescription() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
getDisplayedMethodString() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getDisplayMethodAs() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getDisplayMethodAs() - Method in class org.jsondoc.core.pojo.JSONDoc
 
getField() - Method in class org.jsondoc.core.util.JSONDocFieldWrapper
 
getFields() - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
getFlows() - Method in class org.jsondoc.core.pojo.JSONDoc
 
getFormat() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getFormat() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
getGroup() - Method in class org.jsondoc.core.pojo.ApiDoc
 
getGroup() - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
getGroup() - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
getHeaders() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getId() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getJSONDoc(String, String, List<String>, boolean, JSONDoc.MethodDisplay) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
Returns the main ApiDoc, containing ApiMethodDoc and ApiObjectDoc objects
getJSONDoc(String, String, List<String>, boolean, JSONDoc.MethodDisplay) - Method in interface org.jsondoc.core.scanner.JSONDocScanner
 
getJsondocerrors() - Method in class org.jsondoc.core.pojo.AbstractDoc
 
getJsondochints() - Method in class org.jsondoc.core.pojo.AbstractDoc
 
getJsondocTemplate() - Method in class org.jsondoc.core.pojo.ApiBodyObjectDoc
 
getJsondocTemplate() - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
getJsondocType() - Method in class org.jsondoc.core.pojo.ApiBodyObjectDoc
 
getJsondocType() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getJsondocType() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
getJsondocType() - Method in class org.jsondoc.core.pojo.ApiResponseObjectDoc
 
getJsondocwarnings() - Method in class org.jsondoc.core.pojo.AbstractDoc
 
getMapKey() - Method in class org.jsondoc.core.util.JSONDocType
 
getMapValue() - Method in class org.jsondoc.core.util.JSONDocType
 
getMethods() - Method in class org.jsondoc.core.pojo.ApiDoc
 
getMethods() - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
getName() - Method in class org.jsondoc.core.pojo.ApiDoc
 
getName() - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
getName() - Method in class org.jsondoc.core.pojo.ApiHeaderDoc
 
getName() - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
getName() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getName() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
getObjects() - Method in class org.jsondoc.core.pojo.JSONDoc
 
getOneLineText() - Method in class org.jsondoc.core.util.JSONDocType
 
getOrder() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getOrder() - Method in class org.jsondoc.core.util.JSONDocFieldWrapper
 
getPath() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getPathparameters() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getPreconditions() - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
getProduces() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getQueryparameters() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getRequired() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getRequired() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
getResponse() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getResponsestatuscode() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getRoles() - Method in class org.jsondoc.core.pojo.ApiAuthDoc
 
getSince() - Method in class org.jsondoc.core.pojo.ApiVersionDoc
 
getSteps() - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
getSummary() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getSupportedversions() - Method in class org.jsondoc.core.pojo.ApiDoc
 
getSupportedversions() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getSupportedversions() - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
getSupportedversions() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
getTestusers() - Method in class org.jsondoc.core.pojo.ApiAuthDoc
 
getType() - Method in class org.jsondoc.core.pojo.ApiAuthDoc
 
getType() - Method in class org.jsondoc.core.util.JSONDocType
 
getUntil() - Method in class org.jsondoc.core.pojo.ApiVersionDoc
 
getVerb() - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
getVersion() - Method in class org.jsondoc.core.pojo.JSONDoc
 

H

hashCode() - Method in class org.jsondoc.core.pojo.ApiHeaderDoc
 
hashCode() - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
hashCode() - Method in class org.jsondoc.core.pojo.ApiParamDoc
 

I

isPlaygroundEnabled() - Method in class org.jsondoc.core.pojo.JSONDoc
 

J

JSONDoc - Class in org.jsondoc.core.pojo
 
JSONDoc(String, String) - Constructor for class org.jsondoc.core.pojo.JSONDoc
 
JSONDoc.MethodDisplay - Enum in org.jsondoc.core.pojo
 
JSONDocDefaultType - Class in org.jsondoc.core.util
 
JSONDocDefaultType() - Constructor for class org.jsondoc.core.util.JSONDocDefaultType
 
jsondocerrors - Variable in class org.jsondoc.core.pojo.AbstractDoc
 
JSONDocFieldWrapper - Class in org.jsondoc.core.util
 
JSONDocFieldWrapper(Field, Integer) - Constructor for class org.jsondoc.core.util.JSONDocFieldWrapper
 
jsondochints - Variable in class org.jsondoc.core.pojo.AbstractDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiBodyObjectDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiErrorDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiFlowDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiFlowStepDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiHeaderDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiMethodDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiObjectDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiParamDoc
 
jsondocId - Variable in class org.jsondoc.core.pojo.ApiResponseObjectDoc
 
JSONDocScanner - Interface in org.jsondoc.core.scanner
 
JSONDocTemplate - Class in org.jsondoc.core.pojo
 
JSONDocTemplate() - Constructor for class org.jsondoc.core.pojo.JSONDocTemplate
 
JSONDocTemplateBuilder - Class in org.jsondoc.core.util
 
JSONDocTemplateBuilder() - Constructor for class org.jsondoc.core.util.JSONDocTemplateBuilder
 
JSONDocType - Class in org.jsondoc.core.util
 
JSONDocType() - Constructor for class org.jsondoc.core.util.JSONDocType
 
JSONDocType(String) - Constructor for class org.jsondoc.core.util.JSONDocType
 
JSONDocTypeBuilder - Class in org.jsondoc.core.util
 
JSONDocTypeBuilder() - Constructor for class org.jsondoc.core.util.JSONDocTypeBuilder
 
jsondocwarnings - Variable in class org.jsondoc.core.pojo.AbstractDoc
 

L

log - Static variable in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 

M

mergeApiDoc(Class<?>, ApiDoc) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
mergeApiDoc(Class<?>, ApiDoc) - Method in class org.jsondoc.core.scanner.DefaultJSONDocScanner
 
mergeApiMethodDoc(Method, Class<?>, ApiMethodDoc) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
mergeApiMethodDoc(Method, Class<?>, ApiMethodDoc) - Method in class org.jsondoc.core.scanner.DefaultJSONDocScanner
 
mergeApiPathParamDoc(Method, int, ApiParamDoc) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
mergeApiPathParamDoc(Method, int, ApiParamDoc) - Method in class org.jsondoc.core.scanner.DefaultJSONDocScanner
 
mergeApiQueryParamDoc(Method, int, ApiParamDoc) - Method in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 
mergeApiQueryParamDoc(Method, int, ApiParamDoc) - Method in class org.jsondoc.core.scanner.DefaultJSONDocScanner
 

O

org.jsondoc.core.annotation - package org.jsondoc.core.annotation
 
org.jsondoc.core.pojo - package org.jsondoc.core.pojo
 
org.jsondoc.core.scanner - package org.jsondoc.core.scanner
 
org.jsondoc.core.util - package org.jsondoc.core.util
 

R

reflections - Variable in class org.jsondoc.core.scanner.AbstractJSONDocScanner
 

S

setAllowedvalues(String[]) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
setAllowedvalues(String[]) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setAllowedvalues(String[]) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
setApierrors(List<ApiErrorDoc>) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setApimethoddoc(ApiMethodDoc) - Method in class org.jsondoc.core.pojo.ApiFlowStepDoc
 
setApimethodid(String) - Method in class org.jsondoc.core.pojo.ApiFlowStepDoc
 
setApis(Map<String, Set<ApiDoc>>) - Method in class org.jsondoc.core.pojo.JSONDoc
 
setAuth(ApiAuthDoc) - Method in class org.jsondoc.core.pojo.ApiDoc
 
setAuth(ApiAuthDoc) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setBasePath(String) - Method in class org.jsondoc.core.pojo.JSONDoc
 
setBodyobject(ApiBodyObjectDoc) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setConsumes(Set<String>) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setDefaultvalue(String) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
setDescription(String) - Method in class org.jsondoc.core.pojo.ApiDoc
 
setDescription(String) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
setDescription(String) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setDescription(String) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
setDescription(String) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setDescription(String) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
setDisplayMethodAs(JSONDoc.MethodDisplay) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setDisplayMethodAs(JSONDoc.MethodDisplay) - Method in class org.jsondoc.core.pojo.JSONDoc
 
setField(Field) - Method in class org.jsondoc.core.util.JSONDocFieldWrapper
 
setFields(Set<ApiObjectFieldDoc>) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
setFlows(Map<String, Set<ApiFlowDoc>>) - Method in class org.jsondoc.core.pojo.JSONDoc
 
setFormat(String) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setFormat(String) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
setGroup(String) - Method in class org.jsondoc.core.pojo.ApiDoc
 
setGroup(String) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
setGroup(String) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
setHeaders(Set<ApiHeaderDoc>) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setId(String) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setJsondocerrors(List<String>) - Method in class org.jsondoc.core.pojo.AbstractDoc
 
setJsondochints(List<String>) - Method in class org.jsondoc.core.pojo.AbstractDoc
 
setJsondocTemplate(JSONDocTemplate) - Method in class org.jsondoc.core.pojo.ApiBodyObjectDoc
 
setJsondocTemplate(JSONDocTemplate) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
setJsondocType(JSONDocType) - Method in class org.jsondoc.core.pojo.ApiBodyObjectDoc
 
setJsondocType(JSONDocType) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setJsondocwarnings(List<String>) - Method in class org.jsondoc.core.pojo.AbstractDoc
 
setMapKey(JSONDocType) - Method in class org.jsondoc.core.util.JSONDocType
 
setMapValue(JSONDocType) - Method in class org.jsondoc.core.util.JSONDocType
 
setMethods(Set<ApiMethodDoc>) - Method in class org.jsondoc.core.pojo.ApiDoc
 
setMethods(List<ApiMethodDoc>) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
setName(String) - Method in class org.jsondoc.core.pojo.ApiDoc
 
setName(String) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
setName(String) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
setName(String) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setName(String) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
setObjects(Map<String, Set<ApiObjectDoc>>) - Method in class org.jsondoc.core.pojo.JSONDoc
 
setOrder(int) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setOrder(Integer) - Method in class org.jsondoc.core.util.JSONDocFieldWrapper
 
setPath(String) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setPathparameters(Set<ApiParamDoc>) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setPlaygroundEnabled(boolean) - Method in class org.jsondoc.core.pojo.JSONDoc
 
setPreconditions(List<String>) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
setProduces(Set<String>) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setQueryparameters(Set<ApiParamDoc>) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setRequired(String) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setRequired(String) - Method in class org.jsondoc.core.pojo.ApiParamDoc
 
setResponse(ApiResponseObjectDoc) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setResponsestatuscode(String) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setRoles(List<String>) - Method in class org.jsondoc.core.pojo.ApiAuthDoc
 
setSince(String) - Method in class org.jsondoc.core.pojo.ApiVersionDoc
 
setSteps(List<ApiFlowStepDoc>) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
 
setSummary(String) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setSupportedversions(ApiVersionDoc) - Method in class org.jsondoc.core.pojo.ApiDoc
 
setSupportedversions(ApiVersionDoc) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setSupportedversions(ApiVersionDoc) - Method in class org.jsondoc.core.pojo.ApiObjectDoc
 
setSupportedversions(ApiVersionDoc) - Method in class org.jsondoc.core.pojo.ApiObjectFieldDoc
 
setTestusers(Map<String, String>) - Method in class org.jsondoc.core.pojo.ApiAuthDoc
 
setType(String) - Method in class org.jsondoc.core.pojo.ApiAuthDoc
 
setType(List<String>) - Method in class org.jsondoc.core.util.JSONDocType
 
setUntil(String) - Method in class org.jsondoc.core.pojo.ApiVersionDoc
 
setVerb(ApiVerb) - Method in class org.jsondoc.core.pojo.ApiMethodDoc
 
setVersion(String) - Method in class org.jsondoc.core.pojo.JSONDoc
 

T

toString() - Method in class org.jsondoc.core.pojo.JSONDoc
 

U

UNDEFINED - Static variable in class org.jsondoc.core.scanner.DefaultJSONDocScanner
 

V

valueOf(String) - Static method in enum org.jsondoc.core.pojo.ApiAuthType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jsondoc.core.pojo.ApiParamType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jsondoc.core.pojo.ApiVerb
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jsondoc.core.pojo.JSONDoc.MethodDisplay
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jsondoc.core.pojo.ApiAuthType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jsondoc.core.pojo.ApiParamType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jsondoc.core.pojo.ApiVerb
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jsondoc.core.pojo.JSONDoc.MethodDisplay
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E G H I J L M O R S T U V 
Skip navigation links

Copyright © 2015. All rights reserved.