Package org.glassfish.jersey.wadl.doclet

Class DocProcessorWrapper

java.lang.Object

org.glassfish.jersey.wadl.doclet.DocProcessorWrapper

All Implemented Interfaces:

DocProcessor

public class DocProcessorWrapper
extends Object
implements DocProcessor

Constructor Summary

Constructors

Constructor	Description
DocProcessorWrapper()	Create new DocProcessorWrapper instance.

Method Summary

Modifier and Type	Method	Description
String[]	getCDataElements()	specify which of your elements you want to be handled as CDATA.
Class<?>[]	getRequiredJaxbContextClasses()	Specify jaxb classes of instances that you add to the resourcedoc model.
void	processClassDoc(TypeElement classDoc, ClassDocType classDocType)	Use this method to extend the provided ClassDocType with the information from the given TypeElement.
void	processClassDocWithDocEnv(TypeElement classDoc, ClassDocType classDocType, DocletEnvironment docEnv)	Use this method to extend the provided ClassDocType with the information from the given TypeElement.
void	processMethodDoc(ExecutableElement methodDoc, MethodDocType methodDocType)	Process the provided methodDoc and add your custom information to the methodDocType.
void	processMethodDocWithDocEnv(ExecutableElement methodDoc, MethodDocType methodDocType, DocletEnvironment docEnv)	Process the provided methodDoc and add your custom information to the methodDocType.
void	processParamTag(VariableElement parameter, ParamDocType paramDocType)	Use this method to extend the provided ParamDocType with the information from the given ParamTag and Parameter.
void	processParamTagWithDocEnv(VariableElement parameter, ParamDocType paramDocType, DocletEnvironment docEnv)	Use this method to extend the provided ParamDocType with the information from the given VariableElement.

Methods inherited from class java.lang.Object

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

Constructor Details

DocProcessorWrapper

public DocProcessorWrapper()

Create new DocProcessorWrapper instance.

Method Details

getRequiredJaxbContextClasses

public Class<?>[] getRequiredJaxbContextClasses()

Description copied from interface: DocProcessor

Specify jaxb classes of instances that you add to the resourcedoc model. These classes are added to the list of classes when creating the jaxb context with JAXBContext.newInstance( clazzes );.

Specified by:

getRequiredJaxbContextClasses in interface DocProcessor

Returns:

a list of classes or null

getCDataElements

public String[] getCDataElements()

Description copied from interface: DocProcessor

specify which of your elements you want to be handled as CDATA. The use of the '^' between the namespaceURI and the localname seems to be an implementation detail of the xerces code. When processing xml that doesn't use namespaces, simply omit the namespace prefix as shown in the third CDataElement below.

Specified by:

getCDataElements in interface DocProcessor

Returns:

an Array of element descriptors or null

processClassDoc

public void processClassDoc(TypeElement classDoc,
 ClassDocType classDocType)

Description copied from interface: DocProcessor

Use this method to extend the provided ClassDocType with the information from the given TypeElement.

Specified by:

processClassDoc in interface DocProcessor

Parameters:

classDoc - the class javadoc

classDocType - the ClassDocType to extend. This will later be processed by the WadlGenerators.

processMethodDoc

public void processMethodDoc(ExecutableElement methodDoc,
 MethodDocType methodDocType)

Description copied from interface: DocProcessor

Process the provided methodDoc and add your custom information to the methodDocType.

Specified by:

processMethodDoc in interface DocProcessor

Parameters:

methodDoc - the ExecutableElement representing the docs of your method.

methodDocType - the related MethodDocType that will later be processed by the WadlGenerators.

processParamTag

public void processParamTag(VariableElement parameter,
 ParamDocType paramDocType)

Description copied from interface: DocProcessor

Use this method to extend the provided ParamDocType with the information from the given ParamTag and Parameter.

Specified by:

processParamTag in interface DocProcessor

Parameters:

parameter - the parameter (that is documented or not)

paramDocType - the ParamDocType to extend. This will later be processed by the WadlGenerators.

processClassDocWithDocEnv

public void processClassDocWithDocEnv(TypeElement classDoc,
 ClassDocType classDocType,
 DocletEnvironment docEnv)

Description copied from interface: DocProcessor

Use this method to extend the provided ClassDocType with the information from the given TypeElement.

Specified by:

processClassDocWithDocEnv in interface DocProcessor

Parameters:

classDoc - the class javadoc

classDocType - the ClassDocType to extend. This will later be processed by the WadlGenerators.

docEnv - the doclet environment used to extract info from classDoc

processMethodDocWithDocEnv

public void processMethodDocWithDocEnv(ExecutableElement methodDoc,
 MethodDocType methodDocType,
 DocletEnvironment docEnv)

Description copied from interface: DocProcessor

Process the provided methodDoc and add your custom information to the methodDocType.

Specified by:

processMethodDocWithDocEnv in interface DocProcessor

Parameters:

methodDoc - the ExecutableElement representing the docs of your method.

methodDocType - the related MethodDocType that will later be processed by the WadlGenerators.

docEnv - the doclet environment used to extract info from methodDoc

processParamTagWithDocEnv

public void processParamTagWithDocEnv(VariableElement parameter,
 ParamDocType paramDocType,
 DocletEnvironment docEnv)

Description copied from interface: DocProcessor

Use this method to extend the provided ParamDocType with the information from the given VariableElement.

Specified by:

processParamTagWithDocEnv in interface DocProcessor

Parameters:

parameter - the parameter (that is documented or not)

paramDocType - the ParamDocType to extend. This will later be processed by the WadlGenerators.

docEnv - the Doclet Environment used to extract info from parameter