org.codehaus.mojo.servicedocgen.descriptor

Class ServiceDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

All Implemented Interfaces:

Descriptor

public class ServiceDescriptor
extends AbstractDescriptor

Descriptor of a service.

Author:

hohwille

See Also:

ServicesDescriptor.getServices()

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

Method Summary

Modifier and Type	Method and Description
String	getBasePath()
Set<String>	getConsumes()
String	getDescription()
String	getId()
JType	getJavaType()
String	getName()
List<OperationDescriptor>	getOperations()
Map<String,List<OperationDescriptor>>	getOperationsGroupedByHttpMethod()
Set<String>	getProduces()
void	setBasePath(String basePath)
void	setConsumes(Set<String> consumes)
void	setDescription(String description)
void	setId(String id)
void	setJavaType(JType javaType)
void	setName(String name)
void	setOperations(List<OperationDescriptor> paths)
void	setProduces(Set<String> produces)

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

ServiceDescriptor

public ServiceDescriptor()

Method Detail

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - is the id to set

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - is the name to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - is the description to set

getBasePath

public String getBasePath()

Returns:

the basePath

setBasePath

public void setBasePath(String basePath)

Parameters:

basePath - is the basePath to set

getOperations

public List<OperationDescriptor> getOperations()

Returns:

the paths

getOperationsGroupedByHttpMethod

public Map<String,List<OperationDescriptor>> getOperationsGroupedByHttpMethod()

Returns:

a Map mapping from HTTP-method to OperationDescriptor.

setOperations

public void setOperations(List<OperationDescriptor> paths)

Parameters:

paths - is the paths 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

getJavaType

public JType getJavaType()

Returns:

the javaType

setJavaType

public void setJavaType(JType javaType)

Parameters:

javaType - is the javaType to set