org.jsondoc.core.scanner

Class DefaultJSONDocScanner

java.lang.Object

org.jsondoc.core.scanner.AbstractJSONDocScanner

org.jsondoc.core.scanner.DefaultJSONDocScanner

All Implemented Interfaces:

JSONDocScanner

public class DefaultJSONDocScanner
extends AbstractJSONDocScanner

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS
static String	UNDEFINED

Fields inherited from class org.jsondoc.core.scanner.AbstractJSONDocScanner

allApiMethodDocs, jsondocControllers, jsondocFlows, jsondocMethods, jsondocObjects, log, reflections

Constructor Summary

Constructors

Constructor and Description
DefaultJSONDocScanner()

Method Summary

Modifier and Type	Method and Description
ApiDoc	initApiDoc(Class<?> controller)
ApiMethodDoc	initApiMethodDoc(Method method)
ApiObjectDoc	initApiObjectDoc(Class<?> clazz)
Set<Class<?>>	jsondocControllers()
Set<Class<?>>	jsondocFlows()
Set<Method>	jsondocMethods(Class<?> controller)
Set<Class<?>>	jsondocObjects()
ApiDoc	mergeApiDoc(Class<?> controller, ApiDoc apiDoc)
ApiMethodDoc	mergeApiMethodDoc(Method method, ApiMethodDoc apiMethodDoc)
ApiObjectDoc	mergeApiObjectDoc(Class<?> clazz, ApiObjectDoc apiObjectDoc)

Methods inherited from class org.jsondoc.core.scanner.AbstractJSONDocScanner

enumConstantsToStringArray, getApiDocs, getApiDocsMap, getApiFlowDocs, getApiFlowDocsMap, getApiObjectDocs, getApiObjectsMap, getJSONDoc

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final String UNDEFINED

See Also:

Constant Field Values

ANONYMOUS

public static final String ANONYMOUS

See Also:

Constant Field Values

Constructor Detail

DefaultJSONDocScanner

public DefaultJSONDocScanner()

Method Detail

jsondocControllers

public Set<Class<?>> jsondocControllers()

Specified by:

jsondocControllers in class AbstractJSONDocScanner

jsondocMethods

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

Specified by:

jsondocMethods in class AbstractJSONDocScanner

jsondocObjects

public Set<Class<?>> jsondocObjects()

Specified by:

jsondocObjects in class AbstractJSONDocScanner

jsondocFlows

public Set<Class<?>> jsondocFlows()

Specified by:

jsondocFlows in class AbstractJSONDocScanner

initApiDoc

public ApiDoc initApiDoc(Class<?> controller)

Specified by:

initApiDoc in class AbstractJSONDocScanner

mergeApiDoc

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

Specified by:

mergeApiDoc in class AbstractJSONDocScanner

initApiMethodDoc

public ApiMethodDoc initApiMethodDoc(Method method)

Specified by:

initApiMethodDoc in class AbstractJSONDocScanner

mergeApiMethodDoc

public ApiMethodDoc mergeApiMethodDoc(Method method,
                                      ApiMethodDoc apiMethodDoc)

Specified by:

mergeApiMethodDoc in class AbstractJSONDocScanner

initApiObjectDoc

public ApiObjectDoc initApiObjectDoc(Class<?> clazz)

Specified by:

initApiObjectDoc in class AbstractJSONDocScanner

mergeApiObjectDoc

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

Specified by:

mergeApiObjectDoc in class AbstractJSONDocScanner