com.carma.swagger.doclet.parser

Class CrossClassApiParser

java.lang.Object

com.carma.swagger.doclet.parser.CrossClassApiParser

public class CrossClassApiParser
extends Object

The CrossClassApiParser represents an api class parser that supports ApiDeclaration being spread across multiple resource classes.

Version:

$Id$

Author:

conor.roche

Constructor Summary

Constructors

Constructor and Description
CrossClassApiParser(DocletOptions options, com.sun.javadoc.ClassDoc classDoc, Collection<com.sun.javadoc.ClassDoc> classes, Map<com.sun.javadoc.Type,com.sun.javadoc.ClassDoc> subResourceClasses, Collection<com.sun.javadoc.ClassDoc> typeClasses, String swaggerVersion, String apiVersion, String basePath) This creates a CrossClassApiParser for top level parsing
CrossClassApiParser(DocletOptions options, com.sun.javadoc.ClassDoc classDoc, Collection<com.sun.javadoc.ClassDoc> classes, Map<com.sun.javadoc.Type,com.sun.javadoc.ClassDoc> subResourceClasses, Collection<com.sun.javadoc.ClassDoc> typeClasses, String swaggerVersion, String apiVersion, String basePath, Method parentMethod, String parentResourcePath) This creates a CrossClassApiParser for parsing a subresource

Method Summary

Methods

Modifier and Type	Method and Description
String	getRootPath() This gets the root jaxrs path of the api resource class
void	parse(Map<String,ApiDeclaration> declarations) This parses the api declarations from the resource classes of the api

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossClassApiParser

public CrossClassApiParser(DocletOptions options,
                   com.sun.javadoc.ClassDoc classDoc,
                   Collection<com.sun.javadoc.ClassDoc> classes,
                   Map<com.sun.javadoc.Type,com.sun.javadoc.ClassDoc> subResourceClasses,
                   Collection<com.sun.javadoc.ClassDoc> typeClasses,
                   String swaggerVersion,
                   String apiVersion,
                   String basePath)

This creates a CrossClassApiParser for top level parsing

Parameters:

options - The options for parsing

classDoc - The class doc

classes - The doclet classes to document

typeClasses - Extra type classes that can be used as generic parameters

subResourceClasses - Sub resource doclet classes

swaggerVersion - Swagger version

apiVersion - Overall API version

basePath - Overall base path

CrossClassApiParser

public CrossClassApiParser(DocletOptions options,
                   com.sun.javadoc.ClassDoc classDoc,
                   Collection<com.sun.javadoc.ClassDoc> classes,
                   Map<com.sun.javadoc.Type,com.sun.javadoc.ClassDoc> subResourceClasses,
                   Collection<com.sun.javadoc.ClassDoc> typeClasses,
                   String swaggerVersion,
                   String apiVersion,
                   String basePath,
                   Method parentMethod,
                   String parentResourcePath)

This creates a CrossClassApiParser for parsing a subresource

Parameters:

options - The options for parsing

classDoc - The class doc

classes - The doclet classes to document

typeClasses - Extra type classes that can be used as generic parameters

subResourceClasses - Sub resource doclet classes

swaggerVersion - Swagger version

apiVersion - Overall API version

basePath - Overall base path

parentMethod - The parent method that "owns" this sub resource

parentResourcePath - The parent resource path

Method Detail

getRootPath

public String getRootPath()

This gets the root jaxrs path of the api resource class

Returns:

The root path

parse

public void parse(Map<String,ApiDeclaration> declarations)

This parses the api declarations from the resource classes of the api

Parameters:

declarations - The map of resource name to declaration which will be added to