org.codehaus.mojo.servicedocgen.descriptor

Class ResponseDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

All Implemented Interfaces:

Descriptor

public class ResponseDescriptor
extends AbstractDescriptor

Descriptor of a response to a operation.

Author:

hohwille

See Also:

OperationDescriptor.getResponses()

Field Summary

Fields inherited from interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP_METHOD_DELETE, HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_OPTIONS, HTTP_METHOD_PATCH, HTTP_METHOD_POST, HTTP_METHOD_PUT, LOCATION_BODY, LOCATION_COOKIE, LOCATION_FORM_DATA, LOCATION_HEADER, LOCATION_PATH, LOCATION_QUERY, SCHEME_HTTP, SCHEME_HTTPS, SCHEME_WS, SCHEME_WSS, STATUS_CODE_BAD_REQUEST, STATUS_CODE_CONFLICT, STATUS_CODE_FORBIDDEN, STATUS_CODE_INTERNAL_SERVER_ERROR, STATUS_CODE_NO_CONTENT, STATUS_CODE_SUCCESS, STATUS_CODE_UNAUTHORIZED

Constructor Summary

Constructors

Constructor and Description
ResponseDescriptor()

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getExample()
JElement	getJavaElement()
String	getJavaScriptType()
String	getReason()
String	getStatusCode()
void	setDescription(String description)
void	setExample(String example)
void	setJavaElement(JElement javaElement)
void	setJavaScriptType(String javaScriptType)
void	setReason(String reason)
void	setStatusCode(String statusCode)
String	toString()

Methods inherited from class org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

notNull

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseDescriptor

public ResponseDescriptor()

Method Detail

getStatusCode

public String getStatusCode()

Returns:

the statusCode

setStatusCode

public void setStatusCode(String statusCode)

Parameters:

statusCode - is the statusCode to set

getReason

public String getReason()

Returns:

the reason

setReason

public void setReason(String reason)

Parameters:

reason - is the reason to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - is the description to set

getExample

public String getExample()

Returns:

the example

setExample

public void setExample(String example)

Parameters:

example - is the example to set

getJavaScriptType

public String getJavaScriptType()

Returns:

the javaScriptType

setJavaScriptType

public void setJavaScriptType(String javaScriptType)

Parameters:

javaScriptType - is the javaScriptType to set

getJavaElement

public JElement getJavaElement()

Returns:

the javaElement

setJavaElement

public void setJavaElement(JElement javaElement)

Parameters:

javaElement - is the javaElement to set

toString

public String toString()

Overrides:

toString in class Object