br.com.anteros.restdoc.maven.plugin.doclet.collector

Class AbstractCollector

java.lang.Object

br.com.anteros.restdoc.maven.plugin.doclet.collector.AbstractCollector

All Implemented Interfaces:

Collector

Direct Known Subclasses:

JaxRSCollector, SpringCollector

public abstract class AbstractCollector
extends Object
implements Collector

Author:

Edson Martins, Eduardo Albertini

Constructor Summary

Constructors

Constructor and Description
AbstractCollector()

Method Summary

Modifier and Type	Method and Description
protected abstract Collection<PathVar>	generatePathVars(com.sun.javadoc.MethodDoc methodDoc)
protected abstract Collection<QueryParam>	generateQueryParams(com.sun.javadoc.MethodDoc methodDoc)
protected abstract RequestBody	generateRequestBody(com.sun.javadoc.MethodDoc methodDoc)
protected Collection<Endpoint>	getAllEndpoints(String contextPath, com.sun.javadoc.ClassDoc classDoc, EndpointMapping classMapping) Retrieves all the end point provided in the specified class doc.
protected String	getClassDescription(com.sun.javadoc.ClassDoc classDoc) Will get the description for the class.
protected ClassDescriptor	getClassDescriptor(com.sun.javadoc.ClassDoc classDoc) Will generate a single class descriptor and all the endpoints for that class.
protected String	getClassName(com.sun.javadoc.ClassDoc classDoc) Will get the display name for the class.
protected String	getContextPath(com.sun.javadoc.ClassDoc classDoc) Will get the initial context path to use for all rest endpoint.
Collection<ClassDescriptor>	getDescriptors(com.sun.javadoc.RootDoc rootDoc) Will generate and aggregate all the rest endpoint class descriptors.
protected Collection<Endpoint>	getEndpoint(String contextPath, EndpointMapping classMapping, com.sun.javadoc.MethodDoc method) Retrieves the endpoint for a single method.
protected abstract EndpointMapping	getEndpointMapping(com.sun.javadoc.ProgramElementDoc doc)
protected Collection<String>	resolveConsumesInfo(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 consumeable information.
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 Collection<String>	resolvePaths(String contextPath, EndpointMapping classMapping, EndpointMapping methodMapping) Will generate all the paths specified in the class and method mappings.
protected Collection<String>	resolvesProducesInfo(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 produceable information.
protected abstract boolean	shouldIgnoreClass(com.sun.javadoc.ClassDoc classDoc)
protected abstract boolean	shouldIgnoreMethod(com.sun.javadoc.MethodDoc methodDoc)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCollector

public AbstractCollector()

Method Detail

shouldIgnoreClass

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

shouldIgnoreMethod

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

getEndpointMapping

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

generatePathVars

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

generateQueryParams

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

generateRequestBody

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

getDescriptors

public Collection<ClassDescriptor> getDescriptors(com.sun.javadoc.RootDoc rootDoc)

Will generate and aggregate all the rest endpoint class descriptors.

Specified by:

getDescriptors in interface Collector

Parameters:

rootDoc -

Returns:

getClassDescriptor

protected ClassDescriptor getClassDescriptor(com.sun.javadoc.ClassDoc classDoc)

Will generate a single class descriptor and all the endpoints for that class. If any class contains the special javadoc tag br.com.anteros.restdoclet.util.TagUtils.IGNORE_TAG it will be excluded.

Parameters:

classDoc -

Returns:

getAllEndpoints

protected Collection<Endpoint> getAllEndpoints(String contextPath,
                                               com.sun.javadoc.ClassDoc classDoc,
                                               EndpointMapping classMapping)

Retrieves all the end point provided in the specified class doc.

Parameters:

contextPath -

classDoc -

classMapping -

Returns:

getEndpoint

protected Collection<Endpoint> getEndpoint(String contextPath,
                                           EndpointMapping classMapping,
                                           com.sun.javadoc.MethodDoc method)

Retrieves the endpoint for a single method. If any method contains the special javadoc tag br.com.anteros.restdoclet.util.TagUtils.IGNORE_TAG it will be excluded.

Parameters:

contextPath -

classMapping -

method -

Returns:

getContextPath

protected String getContextPath(com.sun.javadoc.ClassDoc classDoc)

Will get the initial context path to use for all rest endpoint. This looks for the value in a special javadoc tag br.com.anteros.restdoclet.util.TagUtils.CONTEXT_TAG

Parameters:

classDoc -

Returns:

getClassName

protected String getClassName(com.sun.javadoc.ClassDoc classDoc)

Will get the display name for the class. This looks for the value in a special javadoc tag br.com.anteros.restdoclet.util.TagUtils.NAME_TAG

Parameters:

classDoc -

Returns:

getClassDescription

protected String getClassDescription(com.sun.javadoc.ClassDoc classDoc)

Will get the description for the class.

Parameters:

classDoc -

Returns:

resolvePaths

protected Collection<String> resolvePaths(String contextPath,
                                          EndpointMapping classMapping,
                                          EndpointMapping methodMapping)

Will generate all the paths specified in the class and method mappings. Each path should start with the context path, followed by one of the class paths, then finally the method path.

Parameters:

contextPath -

classMapping -

methodMapping -

Returns:

resolveHttpMethods

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.

Parameters:

classMapping -

methodMapping -

Returns:

resolveConsumesInfo

protected Collection<String> resolveConsumesInfo(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 consumeable information.

Parameters:

classMapping -

methodMapping -

Returns:

resolvesProducesInfo

protected Collection<String> resolvesProducesInfo(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 produceable information.

Parameters:

classMapping -

methodMapping -

Returns: