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, log, reflections

Constructor Summary

Constructors

Constructor and Description
DefaultJSONDocScanner()

Method Summary

Modifier and Type	Method and Description
ApiDoc	mergeApiDoc(Class<?> controller, ApiDoc apiDoc)
ApiMethodDoc	mergeApiMethodDoc(Method method, Class<?> controller, ApiMethodDoc apiMethodDoc)
ApiParamDoc	mergeApiPathParamDoc(Method method, int paramIndex, ApiParamDoc apiParamDoc)
ApiParamDoc	mergeApiQueryParamDoc(Method method, int paramIndex, ApiParamDoc apiParamDoc)

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

enumConstantsToStringArray, getApiAuthDocForController, getApiAuthDocForMethod, getApiDocs, getApiDocsMap, getApiFlowDocs, getApiFlowDocsMap, getApiObjectDocs, getApiObjectsMap, getApiPathParamDocs, getApiQueryParamDocs, 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

mergeApiDoc

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

Specified by:

mergeApiDoc in class AbstractJSONDocScanner

mergeApiMethodDoc

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

Specified by:

mergeApiMethodDoc in class AbstractJSONDocScanner

mergeApiPathParamDoc

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

Specified by:

mergeApiPathParamDoc in class AbstractJSONDocScanner

mergeApiQueryParamDoc

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

Specified by:

mergeApiQueryParamDoc in class AbstractJSONDocScanner