com.carma.swagger.doclet.parser

Class ApiMethodParser

java.lang.Object

com.carma.swagger.doclet.parser.ApiMethodParser

public class ApiMethodParser
extends Object

The ApiMethodParser represents a parser for resource methods

Version:

$Id$

Constructor Summary

Constructors

Constructor and Description
ApiMethodParser(DocletOptions options, Method parentMethod, com.sun.javadoc.MethodDoc methodDoc, Collection<com.sun.javadoc.ClassDoc> classes, Collection<com.sun.javadoc.ClassDoc> typeClasses, String classDefaultErrorType) This creates a ApiMethodParser
ApiMethodParser(DocletOptions options, String parentPath, com.sun.javadoc.MethodDoc methodDoc, Collection<com.sun.javadoc.ClassDoc> classes, Collection<com.sun.javadoc.ClassDoc> typeClasses, String classDefaultErrorType) This creates a ApiMethodParser

Method Summary

Methods

Modifier and Type	Method and Description
Set<Model>	models() This gets the parsed models found for this method
Method	parse() This parses a javadoc method doc and builds a pojo representation of it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiMethodParser

public ApiMethodParser(DocletOptions options,
               String parentPath,
               com.sun.javadoc.MethodDoc methodDoc,
               Collection<com.sun.javadoc.ClassDoc> classes,
               Collection<com.sun.javadoc.ClassDoc> typeClasses,
               String classDefaultErrorType)

This creates a ApiMethodParser

Parameters:

options -

parentPath -

methodDoc -

classes -

typeClasses -

classDefaultErrorType -

ApiMethodParser

public ApiMethodParser(DocletOptions options,
               Method parentMethod,
               com.sun.javadoc.MethodDoc methodDoc,
               Collection<com.sun.javadoc.ClassDoc> classes,
               Collection<com.sun.javadoc.ClassDoc> typeClasses,
               String classDefaultErrorType)

This creates a ApiMethodParser

Parameters:

options -

parentMethod -

methodDoc -

classes -

typeClasses -

classDefaultErrorType -

Method Detail

parse

public Method parse()

This parses a javadoc method doc and builds a pojo representation of it.

Returns:

The method with appropriate data set

models

public Set<Model> models()

This gets the parsed models found for this method

Returns:

the set of parsed models found for this method