org.codehaus.mojo.servicedocgen

Class Analyzer

java.lang.Object

org.codehaus.mojo.servicedocgen.Analyzer

public class Analyzer
extends Object

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

Author:

hohwille

See Also:

createServicesDescriptor(List)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION_VOID Description for void results.
static String	RESPONSE_REASON_ERROR Reason for an error (exception).
static String	RESPONSE_REASON_SUCCESS Reason for a valid success result.

Constructor Summary

Constructors

Constructor and Description
Analyzer(org.apache.maven.plugin.logging.Log log, org.apache.maven.project.MavenProject project, ClassLoader projectClassloader, com.thoughtworks.qdox.JavaProjectBuilder builder, ServicesDescriptor descriptor, boolean introspectFields) The constructor.

Method Summary

Modifier and Type	Method and Description
protected String	createExample(OperationDescriptor operationDescriptor, JavaScriptType javaScriptType, JElement element)
protected InfoDescriptor	createInfoDescriptor(InfoDescriptor info)
protected OperationDescriptor	createOperationDescriptor(ServiceDescriptor serviceDescriptor, Method byteMethod)
protected ParameterDescriptor	createParameterDescriptor(ServiceDescriptor serviceDescriptor, OperationDescriptor operationDescriptor, JParameter parameter)
protected ResponseDescriptor	createResponseDescriptor(ServiceDescriptor serviceDescriptor, OperationDescriptor operationDescriptor, JElement javaElement, boolean error)
protected ServiceDescriptor	createServiceDescriptor(com.thoughtworks.qdox.model.JavaClass sourceType)
ServicesDescriptor	createServicesDescriptor(List<com.thoughtworks.qdox.model.JavaClass> serviceClasses) Does the actualy analysis.
protected JavaScriptType	getJavaScriptType(net.sf.mmm.util.reflect.api.GenericType<?> byteType, boolean retrieval)
protected org.apache.maven.plugin.logging.Log	getLog()

Methods inherited from class java.lang.Object

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

Field Detail

RESPONSE_REASON_SUCCESS

public static final String RESPONSE_REASON_SUCCESS

Reason for a valid success result.

See Also:

Constant Field Values

RESPONSE_REASON_ERROR

public static final String RESPONSE_REASON_ERROR

Reason for an error (exception).

See Also:

Constant Field Values

DESCRIPTION_VOID

public static final String DESCRIPTION_VOID

Description for void results.

See Also:

Constant Field Values

Constructor Detail

Analyzer

public Analyzer(org.apache.maven.plugin.logging.Log log,
                org.apache.maven.project.MavenProject project,
                ClassLoader projectClassloader,
                com.thoughtworks.qdox.JavaProjectBuilder builder,
                ServicesDescriptor descriptor,
                boolean introspectFields)

The constructor.

Parameters:

log - the Log.

project - the MavenProject. May be null for testing.

projectClassloader - the ClassLoader to load byte-code.

builder - the JavaProjectBuilder.

descriptor - the pre-configured ServicesDescriptor template.

introspectFields - true to introspect beans using fields, false for getters.

Method Detail

getLog

protected org.apache.maven.plugin.logging.Log getLog()

createServicesDescriptor

public ServicesDescriptor createServicesDescriptor(List<com.thoughtworks.qdox.model.JavaClass> serviceClasses)
                                            throws Exception

Does the actualy analysis.

Parameters:

serviceClasses - the List of service classes.

Returns:

the ServicesDescriptor.

Throws:

Exception - if something goes wrong.

createServiceDescriptor

protected ServiceDescriptor createServiceDescriptor(com.thoughtworks.qdox.model.JavaClass sourceType)
                                             throws Exception

Throws:

Exception

createInfoDescriptor

protected InfoDescriptor createInfoDescriptor(InfoDescriptor info)

createOperationDescriptor

protected OperationDescriptor createOperationDescriptor(ServiceDescriptor serviceDescriptor,
                                                        Method byteMethod)

createParameterDescriptor

protected ParameterDescriptor createParameterDescriptor(ServiceDescriptor serviceDescriptor,
                                                        OperationDescriptor operationDescriptor,
                                                        JParameter parameter)

createResponseDescriptor

protected ResponseDescriptor createResponseDescriptor(ServiceDescriptor serviceDescriptor,
                                                      OperationDescriptor operationDescriptor,
                                                      JElement javaElement,
                                                      boolean error)

getJavaScriptType

protected JavaScriptType getJavaScriptType(net.sf.mmm.util.reflect.api.GenericType<?> byteType,
                                           boolean retrieval)

createExample

protected String createExample(OperationDescriptor operationDescriptor,
                               JavaScriptType javaScriptType,
                               JElement element)