Package org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model

Class MethodDocType

java.lang.Object

org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.MethodDocType

public class MethodDocType
extends Object

The documentation type for methods.
Created on: Jun 12, 2008

Author:

Martin Grotzke (martin.grotzke at freiheit.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	commentText
protected String	methodSignature
protected List<ParamDocType>	paramDoc

Constructor Summary

Constructors

Constructor	Description
MethodDocType()

Method Summary

Modifier and Type	Method	Description
List<Object>	getAny()
String	getCommentText()	Gets the value of the commentText property.
String	getMethodName()	Get the method name.
String	getMethodSignature()	Get the method signature, or null if no method signature has been set for the method.
List<ParamDocType>	getParamDocs()
RequestDocType	getRequestDoc()
ResponseDocType	getResponseDoc()
String	getReturnDoc()
String	getReturnTypeExample()
void	setCommentText(String value)	Sets the value of the commentText property.
void	setMethodName(String methodName)	Set the method name.
void	setMethodSignature(String methodSignature)	Set the unique method signature, including method parameters, if any.
void	setRequestDoc(RequestDocType requestDoc)
void	setResponseDoc(ResponseDocType responseDoc)
void	setReturnDoc(String returnDoc)
void	setReturnTypeExample(String returnTypeExample)

Methods inherited from class java.lang.Object

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

Field Detail

methodSignature

protected String methodSignature

commentText

protected String commentText

paramDoc

protected List<ParamDocType> paramDoc

Constructor Detail

MethodDocType

public MethodDocType()

Method Detail

getParamDocs

public List<ParamDocType> getParamDocs()

getAny

public List<Object> getAny()

getMethodName

public String getMethodName()

Get the method name.

Returns:

the method name.

setMethodName

public void setMethodName(String methodName)

Set the method name.

Parameters:

methodName - the method name to set.

getMethodSignature

public String getMethodSignature()

Get the method signature, or null if no method signature has been set for the method.

This string uniquely identifies the method in case there are multiple methods in the class with the same name.

Returns:

unique method signature within a class.

Since:

2.20

setMethodSignature

public void setMethodSignature(String methodSignature)

Set the unique method signature, including method parameters, if any.

Parameters:

methodSignature - method signature string to set.

Since:

2.20

getCommentText

public String getCommentText()

Gets the value of the commentText property.

Returns:

the commentText

setCommentText

public void setCommentText(String value)

Sets the value of the commentText property.

Parameters:

value - the commentText

getReturnDoc

public String getReturnDoc()

Returns:

the returnDoc

setReturnDoc

public void setReturnDoc(String returnDoc)

Parameters:

returnDoc - the returnDoc to set

getReturnTypeExample

public String getReturnTypeExample()

Returns:

the returnTypeExample

setReturnTypeExample

public void setReturnTypeExample(String returnTypeExample)

Parameters:

returnTypeExample - the returnTypeExample to set

getRequestDoc

public RequestDocType getRequestDoc()

Returns:

the requestDoc

setRequestDoc

public void setRequestDoc(RequestDocType requestDoc)

Parameters:

requestDoc - the requestDoc to set

getResponseDoc

public ResponseDocType getResponseDoc()

Returns:

the responseDoc

setResponseDoc

public void setResponseDoc(ResponseDocType responseDoc)

Parameters:

responseDoc - the responseDoc to set