org.jsondoc.core.scanner

Class AbstractJSONDocScanner

java.lang.Object

org.jsondoc.core.scanner.AbstractJSONDocScanner

All Implemented Interfaces:

JSONDocScanner

Direct Known Subclasses:

DefaultJSONDocScanner

public abstract class AbstractJSONDocScanner
extends Object
implements JSONDocScanner

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ApiMethodDoc>	allApiMethodDocs
protected static org.slf4j.Logger	log
protected org.reflections.Reflections	reflections

Constructor Summary

Constructors

Constructor and Description
AbstractJSONDocScanner()

Method Summary

Modifier and Type	Method and Description
static String[]	enumConstantsToStringArray(Object[] enumConstants)
protected ApiAuthDoc	getApiAuthDocForController(Class<?> clazz)
protected ApiAuthDoc	getApiAuthDocForMethod(Method method, Class<?> clazz)
Set<ApiDoc>	getApiDocs(Set<Class<?>> classes, JSONDoc.MethodDisplay displayMethodAs) Gets the API documentation for the set of classes passed as argument
Map<String,Set<ApiDoc>>	getApiDocsMap(Set<Class<?>> classes, JSONDoc.MethodDisplay displayMethodAs)
Set<ApiFlowDoc>	getApiFlowDocs(Set<Class<?>> classes, List<ApiMethodDoc> apiMethodDocs) Gets the API flow documentation for the set of classes passed as argument
Map<String,Set<ApiFlowDoc>>	getApiFlowDocsMap(Set<Class<?>> classes, List<ApiMethodDoc> apiMethodDocs)
Set<ApiObjectDoc>	getApiObjectDocs(Set<Class<?>> classes)
Map<String,Set<ApiObjectDoc>>	getApiObjectsMap(Set<Class<?>> classes)
Set<ApiParamDoc>	getApiPathParamDocs(Method method)
Set<ApiParamDoc>	getApiQueryParamDocs(Method method)
JSONDoc	getJSONDoc(String version, String basePath, List<String> packages, boolean playgroundEnabled, JSONDoc.MethodDisplay displayMethodAs) Returns the main ApiDoc, containing ApiMethodDoc and ApiObjectDoc objects
abstract ApiDoc	mergeApiDoc(Class<?> controller, ApiDoc apiDoc)
abstract ApiMethodDoc	mergeApiMethodDoc(Method method, Class<?> controller, ApiMethodDoc apiMethodDoc)
abstract ApiParamDoc	mergeApiPathParamDoc(Method method, int paramIndex, ApiParamDoc apiParamDoc)
abstract ApiParamDoc	mergeApiQueryParamDoc(Method method, int paramIndex, ApiParamDoc apiParamDoc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

reflections

protected org.reflections.Reflections reflections

log

protected static org.slf4j.Logger log

allApiMethodDocs

protected List<ApiMethodDoc> allApiMethodDocs

Constructor Detail

AbstractJSONDocScanner

public AbstractJSONDocScanner()

Method Detail

mergeApiDoc

public abstract ApiDoc mergeApiDoc(Class<?> controller,
                                   ApiDoc apiDoc)

mergeApiMethodDoc

public abstract ApiMethodDoc mergeApiMethodDoc(Method method,
                                               Class<?> controller,
                                               ApiMethodDoc apiMethodDoc)

mergeApiPathParamDoc

public abstract ApiParamDoc mergeApiPathParamDoc(Method method,
                                                 int paramIndex,
                                                 ApiParamDoc apiParamDoc)

mergeApiQueryParamDoc

public abstract ApiParamDoc mergeApiQueryParamDoc(Method method,
                                                  int paramIndex,
                                                  ApiParamDoc apiParamDoc)

getJSONDoc

public JSONDoc getJSONDoc(String version,
                          String basePath,
                          List<String> packages,
                          boolean playgroundEnabled,
                          JSONDoc.MethodDisplay displayMethodAs)

Returns the main ApiDoc, containing ApiMethodDoc and ApiObjectDoc objects

Specified by:

getJSONDoc in interface JSONDocScanner

Returns:

An ApiDoc object

getApiDocs

public Set<ApiDoc> getApiDocs(Set<Class<?>> classes,
                              JSONDoc.MethodDisplay displayMethodAs)

Gets the API documentation for the set of classes passed as argument

Specified by:

getApiDocs in interface JSONDocScanner

getApiFlowDocs

public Set<ApiFlowDoc> getApiFlowDocs(Set<Class<?>> classes,
                                      List<ApiMethodDoc> apiMethodDocs)

Gets the API flow documentation for the set of classes passed as argument

Specified by:

getApiFlowDocs in interface JSONDocScanner

getApiPathParamDocs

public Set<ApiParamDoc> getApiPathParamDocs(Method method)

getApiQueryParamDocs

public Set<ApiParamDoc> getApiQueryParamDocs(Method method)

getApiObjectDocs

public Set<ApiObjectDoc> getApiObjectDocs(Set<Class<?>> classes)

Specified by:

getApiObjectDocs in interface JSONDocScanner

getApiDocsMap

public Map<String,Set<ApiDoc>> getApiDocsMap(Set<Class<?>> classes,
                                             JSONDoc.MethodDisplay displayMethodAs)

getApiObjectsMap

public Map<String,Set<ApiObjectDoc>> getApiObjectsMap(Set<Class<?>> classes)

getApiFlowDocsMap

public Map<String,Set<ApiFlowDoc>> getApiFlowDocsMap(Set<Class<?>> classes,
                                                     List<ApiMethodDoc> apiMethodDocs)

getApiAuthDocForController

protected ApiAuthDoc getApiAuthDocForController(Class<?> clazz)

getApiAuthDocForMethod

protected ApiAuthDoc getApiAuthDocForMethod(Method method,
                                            Class<?> clazz)

enumConstantsToStringArray

public static String[] enumConstantsToStringArray(Object[] enumConstants)