com.carma.swagger.doclet.model

Class Method

java.lang.Object

com.carma.swagger.doclet.model.Method

public class Method
extends Object

Constructor Summary

Constructors

Constructor and Description
Method(HttpMethod method, String methodName, String path, List<ApiParameter> apiParameters, List<ApiResponseMessage> responseMessages, String summary, String notes, String returnType, String returnTypeFormat, String returnTypeItemsRef, String returnTypeItemsType, String returnTypeItemsFormat, List<String> consumes, List<String> produces, OperationAuthorizations authorizations, boolean deprecated)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
OperationAuthorizations	getAuthorizations() This gets the authorizations
List<String>	getConsumes() This gets the consumes
HttpMethod	getMethod()
String	getMethodName()
String	getNotes() This gets the notes
List<ApiParameter>	getParameters()
String	getPath()
List<String>	getProduces() This gets the produces
List<ApiResponseMessage>	getResponseMessages()
String	getReturnType() This gets the returnType
String	getReturnTypeFormat() This gets the returnTypeFormat
String	getReturnTypeItemsFormat() This gets the returnTypeItemsFormat
String	getReturnTypeItemsRef() This gets the returnTypeItemsRef
String	getReturnTypeItemsType() This gets the returnTypeItemsType
String	getSummary() This gets the summary
int	hashCode()
boolean	isDeprecated() This gets the deprecated
boolean	isSubResource()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Method

public Method(HttpMethod method,
      String methodName,
      String path,
      List<ApiParameter> apiParameters,
      List<ApiResponseMessage> responseMessages,
      String summary,
      String notes,
      String returnType,
      String returnTypeFormat,
      String returnTypeItemsRef,
      String returnTypeItemsType,
      String returnTypeItemsFormat,
      List<String> consumes,
      List<String> produces,
      OperationAuthorizations authorizations,
      boolean deprecated)

Method Detail

getMethod

public HttpMethod getMethod()

getMethodName

public String getMethodName()

getPath

public String getPath()

getParameters

public List<ApiParameter> getParameters()

getResponseMessages

public List<ApiResponseMessage> getResponseMessages()

getSummary

public String getSummary()

This gets the summary

Returns:

the summary

getNotes

public String getNotes()

This gets the notes

Returns:

the notes

getReturnType

public String getReturnType()

This gets the returnType

Returns:

the returnType

getReturnTypeFormat

public String getReturnTypeFormat()

This gets the returnTypeFormat

Returns:

the returnTypeFormat

getReturnTypeItemsRef

public String getReturnTypeItemsRef()

This gets the returnTypeItemsRef

Returns:

the returnTypeItemsRef

getReturnTypeItemsType

public String getReturnTypeItemsType()

This gets the returnTypeItemsType

Returns:

the returnTypeItemsType

getReturnTypeItemsFormat

public String getReturnTypeItemsFormat()

This gets the returnTypeItemsFormat

Returns:

the returnTypeItemsFormat

isSubResource

public boolean isSubResource()

getConsumes

public List<String> getConsumes()

This gets the consumes

Returns:

the consumes

getProduces

public List<String> getProduces()

This gets the produces

Returns:

the produces

getAuthorizations

public OperationAuthorizations getAuthorizations()

This gets the authorizations

Returns:

the authorizations

isDeprecated

public boolean isDeprecated()

This gets the deprecated

Returns:

the deprecated

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()