com.carma.swagger.doclet.parser

Class ApiModelParser

java.lang.Object

com.carma.swagger.doclet.parser.ApiModelParser

public class ApiModelParser
extends Object

The ApiModelParser represents a parser for api model classes which are used for parameters, resource method return types and model fields.

Version:

$Id$

Constructor Summary

Constructors

Constructor and Description
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType) This creates a ApiModelParser
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, boolean inheritFields) This creates a ApiModelParser
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, boolean consumesMultipart, boolean inheritFields) This creates a ApiModelParser for use when using composite parameter model parsing
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, com.sun.javadoc.ClassDoc[] viewClasses) This creates a ApiModelParser
ApiModelParser(DocletOptions options, Translator translator, com.sun.javadoc.Type rootType, com.sun.javadoc.ClassDoc[] viewClasses, boolean inheritFields) This creates a ApiModelParser

Method Summary

Methods

Modifier and Type	Method and Description
ApiModelParser	addVarsToTypes(Map<String,com.sun.javadoc.Type> varsToTypes) This adds the given vars to types to the ones used by this model
static com.sun.javadoc.Type	getReturnType(DocletOptions options, com.sun.javadoc.Type type) This gets the return type for a resource method, it supports wrapper types
String	getRootModelId() This gets the id of the root model
Set<Model>	parse() This parsers a model class built from parsing this class

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiModelParser

public ApiModelParser(DocletOptions options,
              Translator translator,
              com.sun.javadoc.Type rootType)

This creates a ApiModelParser

Parameters:

options -

translator -

rootType -

ApiModelParser

public ApiModelParser(DocletOptions options,
              Translator translator,
              com.sun.javadoc.Type rootType,
              boolean inheritFields)

This creates a ApiModelParser

Parameters:

options -

translator -

rootType -

inheritFields - whether to inherit fields from super types

ApiModelParser

public ApiModelParser(DocletOptions options,
              Translator translator,
              com.sun.javadoc.Type rootType,
              com.sun.javadoc.ClassDoc[] viewClasses)

This creates a ApiModelParser

Parameters:

options -

translator -

rootType -

viewClasses -

ApiModelParser

public ApiModelParser(DocletOptions options,
              Translator translator,
              com.sun.javadoc.Type rootType,
              com.sun.javadoc.ClassDoc[] viewClasses,
              boolean inheritFields)

This creates a ApiModelParser

Parameters:

options -

translator -

rootType -

viewClasses -

inheritFields - whether to inherit fields from super types

ApiModelParser

public ApiModelParser(DocletOptions options,
              Translator translator,
              com.sun.javadoc.Type rootType,
              boolean consumesMultipart,
              boolean inheritFields)

This creates a ApiModelParser for use when using composite parameter model parsing

Parameters:

options -

translator -

rootType -

consumesMultipart -

inheritFields - whether to inherit fields from super types

Method Detail

addVarsToTypes

public ApiModelParser addVarsToTypes(Map<String,com.sun.javadoc.Type> varsToTypes)

This adds the given vars to types to the ones used by this model

Parameters:

varsToTypes -

Returns:

This

parse

public Set<Model> parse()

This parsers a model class built from parsing this class

Returns:

The set of model classes

getRootModelId

public String getRootModelId()

This gets the id of the root model

Returns:

The id of the root model

getReturnType

public static com.sun.javadoc.Type getReturnType(DocletOptions options,
                                 com.sun.javadoc.Type type)

This gets the return type for a resource method, it supports wrapper types

Parameters:

options -

type -

Returns:

The type to use for the resource method