org.codehaus.mojo.servicedocgen.descriptor

Class ServicesDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

All Implemented Interfaces:

Descriptor

public class ServicesDescriptor
extends AbstractDescriptor

Toplevel Descriptor for all discovered services.

Author:

hohwille

See Also:

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
ServicesDescriptor() The constructor.

Method Summary

Modifier and Type	Method and Description
static ServicesDescriptor	createDefault()
String	getBasePath()
Set<String>	getConsumes()
List<ErrorDescriptor>	getErrors()
ExternalDocumentationDescriptor	getExternalDocs()
String	getHost()
InfoDescriptor	getInfo()
List<JavaDocDescriptor>	getJavadocs()
int	getPort()
Set<String>	getProduces()
String	getSchemaDefinitionJson()
String	getSchemaDefinitionYaml()
Set<String>	getSchemes()
List<ServiceDescriptor>	getServices()
void	setBasePath(String basePath)
void	setConsumes(Set<String> consumes)
void	setErrors(List<ErrorDescriptor> errors)
void	setExternalDocs(ExternalDocumentationDescriptor externalDocs)
void	setHost(String host)
void	setInfo(InfoDescriptor info)
void	setJavadocs(List<JavaDocDescriptor> javadocs)
void	setPort(int port)
void	setProduces(Set<String> produces)
void	setSchemaDefinitionJson(String schemaDefinitionJson)
void	setSchemaDefinitionYaml(String schemaDefinitionYaml)
void	setSchemes(Set<String> schemes)
void	setServices(List<ServiceDescriptor> services)

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

ServicesDescriptor

public ServicesDescriptor()

The constructor.

Method Detail

getInfo

public InfoDescriptor getInfo()

Returns:

the info

setInfo

public void setInfo(InfoDescriptor info)

Parameters:

info - is the info to set

getHost

public String getHost()

Returns:

the host

setHost

public void setHost(String host)

Parameters:

host - is the host to set

getPort

public int getPort()

Returns:

the port

setPort

public void setPort(int port)

Parameters:

port - is the port to set

getBasePath

public String getBasePath()

Returns:

the basePath

setBasePath

public void setBasePath(String basePath)

Parameters:

basePath - is the basePath to set

getJavadocs

public List<JavaDocDescriptor> getJavadocs()

Returns:

the javadocs

setJavadocs

public void setJavadocs(List<JavaDocDescriptor> javadocs)

Parameters:

javadocs - is the javadocs to set

getSchemes

public Set<String> getSchemes()

Returns:

the schemes

setSchemes

public void setSchemes(Set<String> schemes)

Parameters:

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

getServices

public List<ServiceDescriptor> getServices()

Returns:

the services

setServices

public void setServices(List<ServiceDescriptor> services)

Parameters:

services - is the services to set

getErrors

public List<ErrorDescriptor> getErrors()

Returns:

the errors

setErrors

public void setErrors(List<ErrorDescriptor> errors)

Parameters:

errors - is the errors to set

getExternalDocs

public ExternalDocumentationDescriptor getExternalDocs()

Returns:

the externalDocs

setExternalDocs

public void setExternalDocs(ExternalDocumentationDescriptor externalDocs)

Parameters:

externalDocs - is the externalDocs to set

getSchemaDefinitionJson

public String getSchemaDefinitionJson()

Returns:

the schema definition as json

setSchemaDefinitionJson

public void setSchemaDefinitionJson(String schemaDefinitionJson)

Parameters:

schemaDefinitionJson - is the schema definition as json to set

getSchemaDefinitionYaml

public String getSchemaDefinitionYaml()

Returns:

the schema definition as yaml

setSchemaDefinitionYaml

public void setSchemaDefinitionYaml(String schemaDefinitionYaml)

Parameters:

schemaDefinitionYaml - is the schema definition as yaml to set

createDefault

public static ServicesDescriptor createDefault()

Returns:

a new default instance of ServiceDescriptor.