com.carma.swagger.doclet.parser

Class ParameterReader

java.lang.Object

com.carma.swagger.doclet.parser.ParameterReader

public class ParameterReader
extends Object

The ParameterReader represents a utility class that supports reading api parameters

Version:

$Id$

Author:

conor.roche

Constructor Summary

Constructors

Constructor and Description
ParameterReader(DocletOptions options, Collection<com.sun.javadoc.ClassDoc> allClasses) This creates a PathParameterReader

Method Summary

Methods

Modifier and Type	Method and Description
List<ApiParameter>	buildApiParams(com.sun.javadoc.ExecutableMemberDoc method, com.sun.javadoc.Parameter parameter, boolean consumesMultipart, Set<String> allParamNames, Set<Model> models) This builds an Api parameter from a method or constructor parameter
List<String>	getClassLevelParamNames() This gets the names of parameters in the class level @Path expression
void	readClass(com.sun.javadoc.ClassDoc classDoc) This reads a class storing any path parameters from the class level
List<ApiParameter>	readClassLevelParameters(Set<Model> models) This reads a list of class parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterReader

public ParameterReader(DocletOptions options,
               Collection<com.sun.javadoc.ClassDoc> allClasses)

This creates a PathParameterReader

Parameters:

options - the doclet options

allClasses - All classes for looking up types

Method Detail

readClass

public void readClass(com.sun.javadoc.ClassDoc classDoc)

This reads a class storing any path parameters from the class level

Parameters:

classDoc - The class to read

getClassLevelParamNames

public List<String> getClassLevelParamNames()

This gets the names of parameters in the class level @Path expression

Returns:

the list of parameter names reference in the class level expression

readClassLevelParameters

public List<ApiParameter> readClassLevelParameters(Set<Model> models)

This reads a list of class parameters. For a class parameter to be returned it must a) be a variable in the path of the class or one of its methods and b) have a PathParam annotation either on a field or constructor

Parameters:

models - The model set to add any new encountered models to

Returns:

A list of class level api parameters

buildApiParams

public List<ApiParameter> buildApiParams(com.sun.javadoc.ExecutableMemberDoc method,
                                com.sun.javadoc.Parameter parameter,
                                boolean consumesMultipart,
                                Set<String> allParamNames,
                                Set<Model> models)

This builds an Api parameter from a method or constructor parameter

Parameters:

method - The method or constructor

parameter - The parameter to build the api parameter for

consumesMultipart - whether the method consumes multipart

allParamNames - A list of all parameter names on the method

models - The model set to add any new encountered models to

Returns:

The list of parameters (can be multiple if bean params are encountered)