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

Class JaxRSCollector

java.lang.Object

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

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

All Implemented Interfaces:

Collector

public class JaxRSCollector
extends AbstractCollector

Coletor de dados para projetos que utilizam o Framework Jax-RS

Author:

Edson Martins, Eduardo Albertini

See Also:

Framework Jax-RS

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ANNOTATION_PACKAGE
protected static String	CONSUMES_ANNOTATION
protected static String	DELETE_ANNOTATION
protected static String	GET_ANNOTATION
protected static String	HEAD_ANNOTATION
protected static String	PARAM_ANNOTATION
protected static String	PATH_ANNOTATION
protected static String	PATHVAR_ANNOTATION
protected static String	POST_ANNOTATION
protected static String	PRODUCES_ANNOTATION
protected static String	PUT_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
JaxRSCollector()

Method Summary

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 br.com.anteros.restdoc.maven.plugin.doclet.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

ANNOTATION_PACKAGE

protected static final String ANNOTATION_PACKAGE

See Also:

Constant Field Values

PATH_ANNOTATION

protected static final String PATH_ANNOTATION

See Also:

Constant Field Values

GET_ANNOTATION

protected static final String GET_ANNOTATION

See Also:

Constant Field Values

POST_ANNOTATION

protected static final String POST_ANNOTATION

See Also:

Constant Field Values

PUT_ANNOTATION

protected static final String PUT_ANNOTATION

See Also:

Constant Field Values

DELETE_ANNOTATION

protected static final String DELETE_ANNOTATION

See Also:

Constant Field Values

HEAD_ANNOTATION

protected static final String HEAD_ANNOTATION

See Also:

Constant Field Values

CONSUMES_ANNOTATION

protected static final String CONSUMES_ANNOTATION

See Also:

Constant Field Values

PRODUCES_ANNOTATION

protected static final String PRODUCES_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

Constructor Detail

JaxRSCollector

public JaxRSCollector()

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: