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 Set<Class<?>>	jsondocControllers
protected Set<Class<?>>	jsondocFlows
protected Set<Method>	jsondocMethods
protected Set<Class<?>>	jsondocObjects
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)
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)
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	initApiDoc(Class<?> controller)
abstract ApiMethodDoc	initApiMethodDoc(Method method)
abstract ApiObjectDoc	initApiObjectDoc(Class<?> clazz)
abstract Set<Class<?>>	jsondocControllers()
abstract Set<Class<?>>	jsondocFlows()
abstract Set<Method>	jsondocMethods(Class<?> controller)
abstract Set<Class<?>>	jsondocObjects()
abstract ApiDoc	mergeApiDoc(Class<?> controller, ApiDoc apiDoc)
abstract ApiMethodDoc	mergeApiMethodDoc(Method method, ApiMethodDoc apiMethodDoc)
abstract ApiObjectDoc	mergeApiObjectDoc(Class<?> clazz, ApiObjectDoc apiObjectDoc)

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

jsondocControllers

protected Set<Class<?>> jsondocControllers

jsondocMethods

protected Set<Method> jsondocMethods

jsondocObjects

protected Set<Class<?>> jsondocObjects

jsondocFlows

protected Set<Class<?>> jsondocFlows

Constructor Detail

AbstractJSONDocScanner

public AbstractJSONDocScanner()

Method Detail

jsondocControllers

public abstract Set<Class<?>> jsondocControllers()

jsondocMethods

public abstract Set<Method> jsondocMethods(Class<?> controller)

jsondocObjects

public abstract Set<Class<?>> jsondocObjects()

jsondocFlows

public abstract Set<Class<?>> jsondocFlows()

initApiDoc

public abstract ApiDoc initApiDoc(Class<?> controller)

mergeApiDoc

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

initApiMethodDoc

public abstract ApiMethodDoc initApiMethodDoc(Method method)

mergeApiMethodDoc

public abstract ApiMethodDoc mergeApiMethodDoc(Method method,
                                               ApiMethodDoc apiMethodDoc)

initApiObjectDoc

public abstract ApiObjectDoc initApiObjectDoc(Class<?> clazz)

mergeApiObjectDoc

public abstract ApiObjectDoc mergeApiObjectDoc(Class<?> clazz,
                                               ApiObjectDoc apiObjectDoc)

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

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)

enumConstantsToStringArray

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