Class MethodDocType
java.lang.Object
org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.MethodDocType
The documentation type for methods.
Created on: Jun 12, 2008
Created on: Jun 12, 2008
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
private String
protected String
protected List
<ParamDocType> private RequestDocType
private ResponseDocType
private String
private String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAny()
Gets the value of the commentText property.Get the method name.Get the method signature, ornull
if no method signature has been set for the method.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)
-
Field Details
-
methodName
-
methodSignature
-
commentText
-
returnDoc
-
returnTypeExample
-
requestDoc
-
responseDoc
-
paramDoc
-
any
-
-
Constructor Details
-
MethodDocType
public MethodDocType()
-
-
Method Details
-
getParamDocs
-
getAny
-
getMethodName
Get the method name.- Returns:
- the method name.
-
setMethodName
Set the method name.- Parameters:
methodName
- the method name to set.
-
getMethodSignature
Get the method signature, ornull
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
Set the unique method signature, including method parameters, if any.- Parameters:
methodSignature
- method signature string to set.- Since:
- 2.20
-
getCommentText
Gets the value of the commentText property.- Returns:
- the commentText
-
setCommentText
Sets the value of the commentText property.- Parameters:
value
- the commentText
-
getReturnDoc
- Returns:
- the returnDoc
-
setReturnDoc
- Parameters:
returnDoc
- the returnDoc to set
-
getReturnTypeExample
- Returns:
- the returnTypeExample
-
setReturnTypeExample
- Parameters:
returnTypeExample
- the returnTypeExample to set
-
getRequestDoc
- Returns:
- the requestDoc
-
setRequestDoc
- Parameters:
requestDoc
- the requestDoc to set
-
getResponseDoc
- Returns:
- the responseDoc
-
setResponseDoc
- Parameters:
responseDoc
- the responseDoc to set
-