org.calrissian.restdoclet.collector.spring

Class SpringCollector

java.lang.Object

org.calrissian.restdoclet.collector.AbstractCollector

org.calrissian.restdoclet.collector.spring.SpringCollector

All Implemented Interfaces:

Collector

public class SpringCollector
extends AbstractCollector

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONTROLLER_ANNOTATION
protected static String	MAPPING_ANNOTATION
protected static String	PARAM_ANNOTATION
protected static String	PATHVAR_ANNOTATION
protected static String	REQUESTBODY_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
SpringCollector()

Method Summary

Methods

Modifier and Type	Method and Description
protected Collection<PathVar>	generatePathVars(com.sun.javadoc.MethodDoc methodDoc)
protected Collection<QueryParam>	generateQueryParams(com.sun.javadoc.MethodDoc methodDoc)
protected RequestBody	generateRequestBody(com.sun.javadoc.MethodDoc methodDoc)
protected EndpointMapping	getEndpointMapping(com.sun.javadoc.ProgramElementDoc doc)
protected Collection<String>	resolveHttpMethods(EndpointMapping classMapping, EndpointMapping methodMapping) Will use the method's mapped information if it is not empty, otherwise it will use the class mapping information to retrieve all the https methods.
protected boolean	shouldIgnoreClass(com.sun.javadoc.ClassDoc classDoc)
protected boolean	shouldIgnoreMethod(com.sun.javadoc.MethodDoc methodDoc)

Methods inherited from class org.calrissian.restdoclet.collector.AbstractCollector

getAllEndpoints, getClassDescription, getClassDescriptor, getClassName, getContextPath, getDescriptors, getEndpoint, resolveConsumesInfo, resolvePaths, resolvesProducesInfo

Methods inherited from class java.lang.Object

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

Field Detail

CONTROLLER_ANNOTATION

protected static final String CONTROLLER_ANNOTATION

See Also:

Constant Field Values

MAPPING_ANNOTATION

protected static final String MAPPING_ANNOTATION

See Also:

Constant Field Values

PATHVAR_ANNOTATION

protected static final String PATHVAR_ANNOTATION

See Also:

Constant Field Values

PARAM_ANNOTATION

protected static final String PARAM_ANNOTATION

See Also:

Constant Field Values

REQUESTBODY_ANNOTATION

protected static final String REQUESTBODY_ANNOTATION

See Also:

Constant Field Values

Constructor Detail

SpringCollector

public SpringCollector()

Method Detail

shouldIgnoreClass

protected boolean shouldIgnoreClass(com.sun.javadoc.ClassDoc classDoc)

Specified by:

shouldIgnoreClass in class AbstractCollector

shouldIgnoreMethod

protected boolean shouldIgnoreMethod(com.sun.javadoc.MethodDoc methodDoc)

Specified by:

shouldIgnoreMethod in class AbstractCollector

getEndpointMapping

protected EndpointMapping getEndpointMapping(com.sun.javadoc.ProgramElementDoc doc)

Specified by:

getEndpointMapping in class AbstractCollector

generatePathVars

protected Collection<PathVar> generatePathVars(com.sun.javadoc.MethodDoc methodDoc)

Specified by:

generatePathVars in class AbstractCollector

generateQueryParams

protected Collection<QueryParam> generateQueryParams(com.sun.javadoc.MethodDoc methodDoc)

Specified by:

generateQueryParams in class AbstractCollector

generateRequestBody

protected RequestBody generateRequestBody(com.sun.javadoc.MethodDoc methodDoc)

Specified by:

generateRequestBody in class AbstractCollector

resolveHttpMethods

protected Collection<String> resolveHttpMethods(EndpointMapping classMapping,
                                    EndpointMapping methodMapping)

Description copied from class: AbstractCollector

Will use the method's mapped information if it is not empty, otherwise it will use the class mapping information to retrieve all the https methods.

Overrides:

resolveHttpMethods in class AbstractCollector

Returns: