com.j256.springrequestdoclet.collector

Class MethodInfo

java.lang.Object

com.j256.springrequestdoclet.collector.MethodInfo

All Implemented Interfaces:

Comparable<MethodInfo>

public class MethodInfo
extends Object
implements Comparable<MethodInfo>

Method information which refines the request path and adds other narrowing fields.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
MethodInfo(String javaMethodName, String uniqueName, String javaDoc, String javaDocFirstSentence, String[] paths, String[] httpMethods, String[] params, String[] headers, String[] consumes, String[] produces, List<ParamInfo> paramInfos, ContentsInfo requestInfo, ContentsInfo responseInfo)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MethodInfo other)
String[]	getConsumes()
String[]	getHeaders()
String[]	getHttpMethods()
String	getJavaDoc()
String	getJavaDocFirstSentence()
String	getJavaMethodName()
List<ParamInfo>	getParamInfos()
String[]	getParams()
String[]	getPaths()
String[]	getProduces()
ContentsInfo	getRequestInfo()
ContentsInfo	getResponseInfo()
String	getUniqueName()

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodInfo

public MethodInfo(String javaMethodName,
          String uniqueName,
          String javaDoc,
          String javaDocFirstSentence,
          String[] paths,
          String[] httpMethods,
          String[] params,
          String[] headers,
          String[] consumes,
          String[] produces,
          List<ParamInfo> paramInfos,
          ContentsInfo requestInfo,
          ContentsInfo responseInfo)

Method Detail

getJavaMethodName

public String getJavaMethodName()

getUniqueName

public String getUniqueName()

getJavaDoc

public String getJavaDoc()

getJavaDocFirstSentence

public String getJavaDocFirstSentence()

getPaths

public String[] getPaths()

getHttpMethods

public String[] getHttpMethods()

getParams

public String[] getParams()

getHeaders

public String[] getHeaders()

getConsumes

public String[] getConsumes()

getProduces

public String[] getProduces()

getParamInfos

public List<ParamInfo> getParamInfos()

getRequestInfo

public ContentsInfo getRequestInfo()

getResponseInfo

public ContentsInfo getResponseInfo()

compareTo

public int compareTo(MethodInfo other)

Specified by:

compareTo in interface Comparable<MethodInfo>