Package org.glassfish.jersey.wadl.doclet

Interface DocProcessor

All Known Implementing Classes:
DocProcessorWrapper
public interface DocProcessor
A doc processor is handed over javadoc elements so that it can turn this into resource doc elements, even self defined.
Author:
Martin Grotzke (martin.grotzke at freiheit.com)

  • Method Details

    • getRequiredJaxbContextClasses

      Class<?>[] getRequiredJaxbContextClasses()
      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 );.
      Returns:
      a list of classes or null

    • getCDataElements

      String[] getCDataElements()
      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.
      Returns:
      an Array of element descriptors or null

    • processClassDoc

      @Deprecated void processClassDoc(TypeElement classDoc, ClassDocType classDocType)
      Deprecated.
      Use this method to extend the provided ClassDocType with the information from the given TypeElement.
      Parameters:
      classDoc - the class javadoc
      classDocType - the ClassDocType to extend. This will later be processed by the WadlGenerators.

    • processMethodDoc

      @Deprecated void processMethodDoc(ExecutableElement methodDoc, MethodDocType methodDocType)
      Deprecated.
      Process the provided methodDoc and add your custom information to the methodDocType.
      Parameters:
      methodDoc - the ExecutableElement representing the docs of your method.
      methodDocType - the related MethodDocType that will later be processed by the WadlGenerators.

    • processParamTag

      @Deprecated void processParamTag(VariableElement parameter, ParamDocType paramDocType)
      Deprecated.
      Use this method to extend the provided ParamDocType with the information from the given ParamTag and Parameter.
      Parameters:
      parameter - the parameter (that is documented or not)
      paramDocType - the ParamDocType to extend. This will later be processed by the WadlGenerators.

    • processClassDocWithDocEnv

      default void processClassDocWithDocEnv(TypeElement classDoc, ClassDocType classDocType, DocletEnvironment docEnv)
      Use this method to extend the provided ClassDocType with the information from the given TypeElement.
      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

      default void processMethodDocWithDocEnv(ExecutableElement methodDoc, MethodDocType methodDocType, DocletEnvironment docEnv)
      Process the provided methodDoc and add your custom information to the methodDocType.
      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

      default void processParamTagWithDocEnv(VariableElement parameter, ParamDocType paramDocType, DocletEnvironment docEnv)
      Use this method to extend the provided ParamDocType with the information from the given VariableElement.
      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