A B C D E G H I J L N O P R S T U V

A

AbstractDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

AbstractDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

Analyzer - Class in org.codehaus.mojo.servicedocgen

Analyzer contains the logic to analyze the services on byte-code and source-code level and create the according Descriptors.

Analyzer(Log, MavenProject, ClassLoader, JavaProjectBuilder, ServicesDescriptor, boolean) - Constructor for class org.codehaus.mojo.servicedocgen.Analyzer

The constructor.

appendPath(String, String) - Static method in class org.codehaus.mojo.servicedocgen.Util

B

builder - Variable in class org.codehaus.mojo.servicedocgen.introspection.JavaDocHelper

C

canGenerateReport() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

compareTo(OperationDescriptor) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

ContactDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor for contact information.

ContactDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

containsSubstring(Set<String>, String) - Static method in class org.codehaus.mojo.servicedocgen.Util

createDefault() - Static method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

createExample(OperationDescriptor, JavaScriptType, JElement) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

createInfoDescriptor(InfoDescriptor) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

createOperationDescriptor(ServiceDescriptor, Method) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

createParameterDescriptor(ServiceDescriptor, OperationDescriptor, JParameter) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

createResponseDescriptor(ServiceDescriptor, OperationDescriptor, JElement, boolean) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

createServiceDescriptor(JavaClass) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

createServicesDescriptor(List<JavaClass>) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

Does the actualy analysis.

D

DEFAULT_JSON_EXAMPLE - Static variable in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

Default for ErrorDescriptor.getJsonExample().

DEFAULT_XML_EXAMPLE - Static variable in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

Default for ErrorDescriptor.getXmlExample().

DESCRIPTION_VOID - Static variable in class org.codehaus.mojo.servicedocgen.Analyzer

Description for void results.

Descriptor - Interface in org.codehaus.mojo.servicedocgen.descriptor

Interface for a descriptor with meta-data about services.

E

ErrorDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor for errors/exceptions (any kind of Throwable).

ErrorDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

ErrorDescriptor.Match - Enum in org.codehaus.mojo.servicedocgen.descriptor

Mode to match error name.

EscapeHelper - Class in org.codehaus.mojo.servicedocgen

Class with static methods for escaping strings in velocity templates.

EscapeHelper() - Constructor for class org.codehaus.mojo.servicedocgen.EscapeHelper

escapeJson(String) - Static method in class org.codehaus.mojo.servicedocgen.EscapeHelper

execute() - Method in class org.codehaus.mojo.servicedocgen.HelpMojo

execute() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

executeReport(Locale) - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

ExternalDocumentationDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor for external documentation sources.

ExternalDocumentationDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.ExternalDocumentationDescriptor

G

generate(ServicesDescriptor, File, String, String) - Method in interface org.codehaus.mojo.servicedocgen.generation.ServicesGenerator

Generates the documentation as output.

generate(ServicesDescriptor, File, String, String) - Method in class org.codehaus.mojo.servicedocgen.generation.velocity.VelocityServicesGenerator

Generates the documentation as output.

getBasePath() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getBasePath() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getBundle(Locale) - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

getByteAnnotations() - Method in class org.codehaus.mojo.servicedocgen.introspection.JParameter

getByteMethod() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getByteType() - Method in class org.codehaus.mojo.servicedocgen.introspection.JElement

getByteTypeString() - Method in class org.codehaus.mojo.servicedocgen.introspection.JElement

getComment() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

getComment() - Method in class org.codehaus.mojo.servicedocgen.introspection.JElement

getComment() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getConsumes() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getConsumes() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getConsumes() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getContact() - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

getDefaultValue() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

getDescription() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ExternalDocumentationDescriptor

getDescription() - Method in class org.codehaus.mojo.servicedocgen.descriptor.HeaderDescriptor

getDescription() - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

getDescription() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getDescription() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

getDescription() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

getDescription() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getDescription(Locale) - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

getEmail() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

getErrorClass() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

getErrorName() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

getErrorNamePattern() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

getErrors() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getExample() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

getExample() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

getExample() - Method in enum org.codehaus.mojo.servicedocgen.JavaScriptType

getExceptions() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getExternalDocs() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getFormat() - Method in class org.codehaus.mojo.servicedocgen.descriptor.HeaderDescriptor

getHost() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getHref() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

getHttpMethod() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getId() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getId() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getInfo() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getJavadocs() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getJavaElement() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

getJavaMethod() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getJavaParameter() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

getJavaScriptType(GenericType<?>, boolean) - Method in class org.codehaus.mojo.servicedocgen.Analyzer

getJavaScriptType() - Method in class org.codehaus.mojo.servicedocgen.descriptor.HeaderDescriptor

getJavaScriptType() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

getJavaScriptType() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

getJavaType() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getJsonExample() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

getLicense() - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

getLocation() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

getLog() - Method in class org.codehaus.mojo.servicedocgen.Analyzer

getMatch() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

getName() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

getName() - Method in class org.codehaus.mojo.servicedocgen.descriptor.LicenseDescriptor

getName() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

getName() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getName() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getName() - Method in class org.codehaus.mojo.servicedocgen.introspection.JParameter

getName() - Method in enum org.codehaus.mojo.servicedocgen.JavaScriptType

getName(Locale) - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

getOperations() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getOperationsGroupedByHttpMethod() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getOutputDirectoryPath() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

getOutputName() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

getOutputName() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

getOutputNameWithFallback() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

getPackagePrefix() - Method in class org.codehaus.mojo.servicedocgen.descriptor.JavaDocDescriptor

getParameter() - Method in class org.codehaus.mojo.servicedocgen.introspection.JParameter

getParameters() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getParameters() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getPath() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getPort() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getProduces() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getProduces() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

getProduces() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getQualifiedName(JavaSource, String) - Method in class org.codehaus.mojo.servicedocgen.introspection.JavaDocHelper

getReason() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

getResponses() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

getReturns() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getSchemaDefinitionJson() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getSchemaDefinitionYaml() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getSchemes() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getServices() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

getSimpleName(String) - Static method in class org.codehaus.mojo.servicedocgen.Util

getSourceMethod() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getSourceType() - Method in class org.codehaus.mojo.servicedocgen.introspection.JElement

getStatusCode() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

getStatusCode() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

getTemplateName() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

getTermsOfService() - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

getTitle() - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

getTrimmed(String) - Static method in class org.codehaus.mojo.servicedocgen.Util

getType() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

getUrl() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

getUrl() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ExternalDocumentationDescriptor

getUrl() - Method in class org.codehaus.mojo.servicedocgen.descriptor.JavaDocDescriptor

getUrl() - Method in class org.codehaus.mojo.servicedocgen.descriptor.LicenseDescriptor

getVersion() - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

getXmlExample() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

H

HeaderDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor for header information.

HeaderDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.HeaderDescriptor

HelpMojo - Class in org.codehaus.mojo.servicedocgen

Display help information on servicedocgen-maven-plugin.
Call mvn servicedocgen:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.codehaus.mojo.servicedocgen.HelpMojo

HTTP_METHOD_DELETE - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP DELETE method.

HTTP_METHOD_GET - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP GET method.

HTTP_METHOD_HEAD - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP HEAD method.

HTTP_METHOD_OPTIONS - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP OPTIONS method.

HTTP_METHOD_PATCH - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP PATCH method.

HTTP_METHOD_POST - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP POST method.

HTTP_METHOD_PUT - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP PUT method.

I

InfoDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor for generic information and configuration.

InfoDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

isDeprecated() - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

isEmpty(String) - Static method in class org.codehaus.mojo.servicedocgen.Util

isExternalReport() - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

isRequired() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

J

JAVADOC_JAVAEE_URL - Static variable in class org.codehaus.mojo.servicedocgen.introspection.JavaDocHelper

JavaDoc URL for Java Enterprise Edition.

JAVADOC_JAVASE_URL - Static variable in class org.codehaus.mojo.servicedocgen.introspection.JavaDocHelper

JavaDoc URL for Java Standard Edition.

JavaDocDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor for URL mapping configuration to create JavaDoc links.

JavaDocDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.JavaDocDescriptor

The constructor.

JavaDocDescriptor(String, String) - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.JavaDocDescriptor

The constructor.

JavaDocHelper - Class in org.codehaus.mojo.servicedocgen.introspection

Helper to parse JavaDoc tags and transform to regular HTML.

JavaDocHelper(ClassLoader, JavaProjectBuilder, List<JavaDocDescriptor>) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JavaDocHelper

The constructor.

JavaScriptType - Enum in org.codehaus.mojo.servicedocgen

Enum with types available in JavaScript.

JElement - Class in org.codehaus.mojo.servicedocgen.introspection

JElement(GenericType<?>, JavaClass, String) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JElement

The constructor.

JException - Class in org.codehaus.mojo.servicedocgen.introspection

An exception declaration of a JMethod.

JException(GenericType<?>, JavaClass, String) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JException

The constructor.

JMethod - Class in org.codehaus.mojo.servicedocgen.introspection

Rich representation of a Method with both byte-code and source-code analysis information.

JMethod(Method, JType) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JMethod

The constructor.

JMethod(Method, JType, Method) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JMethod

The constructor.

JParameter - Class in org.codehaus.mojo.servicedocgen.introspection

A parameter declaration of a JMethod.

JParameter(GenericType<?>, Annotation[], JavaParameter, String, int) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JParameter

The constructor.

JReturn - Class in org.codehaus.mojo.servicedocgen.introspection

An return declaration of a JMethod.

JReturn(GenericType<?>, JavaClass, String) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JReturn

The constructor.

JType - Class in org.codehaus.mojo.servicedocgen.introspection

Rich representation of a Class with both byte-code and source-code analysis.

JType(GenericType<?>, JavaClass, ReflectionUtil, JavaDocHelper) - Constructor for class org.codehaus.mojo.servicedocgen.introspection.JType

The constructor.

L

LicenseDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor for license information.

LicenseDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.LicenseDescriptor

LOCATION_BODY - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP BODY method.

LOCATION_COOKIE - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

REST parameter location for cookie.

LOCATION_FORM_DATA - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

REST parameter location for form data.

LOCATION_HEADER - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP HEADER method.

LOCATION_PATH - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

REST parameter location for URL path.

LOCATION_QUERY - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP QUERY method.

N

notNull(String) - Static method in class org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

O

OperationDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor of an operation of a service.

OperationDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

org.codehaus.mojo.servicedocgen - package org.codehaus.mojo.servicedocgen

org.codehaus.mojo.servicedocgen.descriptor - package org.codehaus.mojo.servicedocgen.descriptor

org.codehaus.mojo.servicedocgen.generation - package org.codehaus.mojo.servicedocgen.generation

org.codehaus.mojo.servicedocgen.generation.velocity - package org.codehaus.mojo.servicedocgen.generation.velocity

org.codehaus.mojo.servicedocgen.introspection - package org.codehaus.mojo.servicedocgen.introspection

outputDirectory - Variable in class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

P

ParameterDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor of a parameter of an operation.

ParameterDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

parseJavaDoc(JavaClass, GenericType<?>, String) - Method in class org.codehaus.mojo.servicedocgen.introspection.JavaDocHelper

Parses JavaDoc and resolves tags such as @link, @linkplain, @literal, @value, or @code.

R

RESPONSE_REASON_ERROR - Static variable in class org.codehaus.mojo.servicedocgen.Analyzer

Reason for an error (exception).

RESPONSE_REASON_SUCCESS - Static variable in class org.codehaus.mojo.servicedocgen.Analyzer

Reason for a valid success result.

ResponseDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor of a response to a operation.

ResponseDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

S

SCHEME_HTTP - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

Protocol scheme for HTTP (HypterText Transfer Protocol).

SCHEME_HTTPS - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

Protocol scheme for HTTPS (HTTP Secured).

SCHEME_WS - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

Protocol scheme for WS (Web Socket).

SCHEME_WSS - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

Protocol scheme for WSS (Web Socket Secured).

ServiceDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Descriptor of a service.

ServiceDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

ServiceDocGenReport - Class in org.codehaus.mojo.servicedocgen

Maven Plugin to automatically generate documentation for services of the current project.

ServiceDocGenReport() - Constructor for class org.codehaus.mojo.servicedocgen.ServiceDocGenReport

ServiceDocGenTemplate - Class in org.codehaus.mojo.servicedocgen

ServiceDocGenTemplate is a template bean representing the templates passed into ServiceDocGenReport

ServiceDocGenTemplate() - Constructor for class org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

ServiceDocGenTemplate(String) - Constructor for class org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

ServicesDescriptor - Class in org.codehaus.mojo.servicedocgen.descriptor

Toplevel Descriptor for all discovered services.

ServicesDescriptor() - Constructor for class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

The constructor.

ServicesGenerator - Interface in org.codehaus.mojo.servicedocgen.generation

Interface for a generator that creates documentation for a given ServicesDescriptor.

setBasePath(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setBasePath(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setComment(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

setConsumes(Set<String>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setConsumes(Set<String>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setConsumes(Set<String>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setContact(ContactDescriptor) - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

setDefaultValue(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setDeprecated(boolean) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setDescription(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ExternalDocumentationDescriptor

setDescription(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.HeaderDescriptor

setDescription(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

setDescription(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setDescription(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setDescription(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

setDescription(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setEmail(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

setErrorClass(Class<?>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

setErrorName(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

setErrors(List<ErrorDescriptor>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setExample(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setExample(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

setExternalDocs(ExternalDocumentationDescriptor) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setFormat(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.HeaderDescriptor

setHost(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setHttpMethod(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setId(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setId(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setInfo(InfoDescriptor) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setJavadocs(List<JavaDocDescriptor>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setJavaElement(JElement) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

setJavaMethod(JMethod) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setJavaParameter(JParameter) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setJavaScriptType(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.HeaderDescriptor

setJavaScriptType(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setJavaScriptType(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

setJavaType(JType) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setJsonExample(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

setLicense(LicenseDescriptor) - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

setLocation(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setMatch(ErrorDescriptor.Match) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

setName(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

setName(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.LicenseDescriptor

setName(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setName(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setOperations(List<OperationDescriptor>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setOutputName(String) - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

setPackagePrefix(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.JavaDocDescriptor

setParameters(List<ParameterDescriptor>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setPath(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setPort(int) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setProduces(Set<String>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setProduces(Set<String>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServiceDescriptor

setProduces(Set<String>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setReason(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

setRequired(boolean) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ParameterDescriptor

setResponses(List<ResponseDescriptor>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.OperationDescriptor

setSchemaDefinitionJson(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setSchemaDefinitionYaml(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setSchemes(Set<String>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setServices(List<ServiceDescriptor>) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor

setStatusCode(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

setStatusCode(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

setTemplateName(String) - Method in class org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

setTermsOfService(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

setTitle(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

setUrl(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ContactDescriptor

setUrl(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ExternalDocumentationDescriptor

setUrl(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.JavaDocDescriptor

setUrl(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.LicenseDescriptor

setVersion(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.InfoDescriptor

setXmlExample(String) - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

STATUS_CODE_BAD_REQUEST - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP status code for bad request.

STATUS_CODE_CONFLICT - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP status code for conflict.

STATUS_CODE_FORBIDDEN - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP status code for unauthorized (permission denied).

STATUS_CODE_INTERNAL_SERVER_ERROR - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP status code for internal server error.

STATUS_CODE_NO_CONTENT - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP status code for success without content.

STATUS_CODE_SUCCESS - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP status code for success with content.

STATUS_CODE_UNAUTHORIZED - Static variable in interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP status code for unauthorized (authentication required).

T

toString() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

toString() - Method in class org.codehaus.mojo.servicedocgen.descriptor.ResponseDescriptor

toString() - Method in class org.codehaus.mojo.servicedocgen.introspection.JException

toString() - Method in class org.codehaus.mojo.servicedocgen.introspection.JMethod

toString() - Method in class org.codehaus.mojo.servicedocgen.introspection.JParameter

toString() - Method in class org.codehaus.mojo.servicedocgen.introspection.JReturn

toString() - Method in class org.codehaus.mojo.servicedocgen.introspection.JType

toString() - Method in enum org.codehaus.mojo.servicedocgen.JavaScriptType

toString(Object, String) - Static method in class org.codehaus.mojo.servicedocgen.Util

U

Util - Class in org.codehaus.mojo.servicedocgen

Utility class with static helper methods.

V

valueOf(String) - Static method in enum org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor.Match

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codehaus.mojo.servicedocgen.JavaScriptType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor.Match

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codehaus.mojo.servicedocgen.JavaScriptType

Returns an array containing the constants of this enum type, in the order they are declared.

VelocityServicesGenerator - Class in org.codehaus.mojo.servicedocgen.generation.velocity

Implementation of ServicesDescriptor based on apache velocity.

VelocityServicesGenerator(String) - Constructor for class org.codehaus.mojo.servicedocgen.generation.velocity.VelocityServicesGenerator

The constructor.

A B C D E G H I J L N O P R S T U V