org.codehaus.mojo.servicedocgen.descriptor

Class OperationDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

All Implemented Interfaces:

Comparable<OperationDescriptor>, Descriptor

public class OperationDescriptor
extends AbstractDescriptor
implements Comparable<OperationDescriptor>

Descriptor of an operation of a service.

Author:

hohwille

See Also:

ServiceDescriptor.getOperations()

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
OperationDescriptor()

Method Summary

Modifier and Type	Method and Description
int	compareTo(OperationDescriptor o)
Set<String>	getConsumes()
String	getDescription()
String	getHttpMethod()
String	getId()
JMethod	getJavaMethod()
List<ParameterDescriptor>	getParameters()
String	getPath()
Set<String>	getProduces()
List<ResponseDescriptor>	getResponses()
boolean	isDeprecated()
void	setConsumes(Set<String> consumes)
void	setDeprecated(boolean deprecated)
void	setDescription(String description)
void	setHttpMethod(String method)
void	setId(String id)
void	setJavaMethod(JMethod javaMethod)
void	setParameters(List<ParameterDescriptor> parameters)
void	setPath(String path)
void	setProduces(Set<String> produces)
void	setResponses(List<ResponseDescriptor> responses)

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, toString, wait, wait, wait

Constructor Detail

OperationDescriptor

public OperationDescriptor()

Method Detail

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - is the id to set

getPath

public String getPath()

Returns:

the path

setPath

public void setPath(String path)

Parameters:

path - is the path to set

getHttpMethod

public String getHttpMethod()

Returns:

the method

setHttpMethod

public void setHttpMethod(String method)

Parameters:

method - is the method to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - is the description to set

isDeprecated

public boolean isDeprecated()

Returns:

the deprecated

setDeprecated

public void setDeprecated(boolean deprecated)

Parameters:

deprecated - is the deprecated to set

getConsumes

public Set<String> getConsumes()

Returns:

the consumes

setConsumes

public void setConsumes(Set<String> consumes)

Parameters:

consumes - is the consumes to set

getProduces

public Set<String> getProduces()

Returns:

the produces

setProduces

public void setProduces(Set<String> produces)

Parameters:

produces - is the produces to set

getParameters

public List<ParameterDescriptor> getParameters()

Returns:

the parameters

setParameters

public void setParameters(List<ParameterDescriptor> parameters)

Parameters:

parameters - is the parameters to set

getResponses

public List<ResponseDescriptor> getResponses()

Returns:

the responses

setResponses

public void setResponses(List<ResponseDescriptor> responses)

Parameters:

responses - is the responses to set

getJavaMethod

public JMethod getJavaMethod()

Returns:

the javaMethod

setJavaMethod

public void setJavaMethod(JMethod javaMethod)

Parameters:

javaMethod - is the javaMethod to set

compareTo

public int compareTo(OperationDescriptor o)

Specified by:

compareTo in interface Comparable<OperationDescriptor>