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 Summary

      All Methods Instance Methods Abstract Methods 
      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​(ClassDoc classDoc, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ClassDocType classDocType)
      Use this method to extend the provided ClassDocType with the information from the given ClassDoc.
      void processMethodDoc​(MethodDoc methodDoc, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.MethodDocType methodDocType)
      Process the provided methodDoc and add your custom information to the methodDocType.
      Use e.g.
      void processParamTag​(ParamTag paramTag, Parameter parameter, org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ParamDocType paramDocType)
      Use this method to extend the provided ParamDocType with the information from the given ParamTag and Parameter.

    • Method Detail

      • 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

        void processClassDoc​(ClassDoc classDoc,
                     org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ClassDocType classDocType)
        Use this method to extend the provided ClassDocType with the information from the given ClassDoc.
        Parameters:
        classDoc - the class javadoc
        classDocType - the ClassDocType to extend. This will later be processed by the WadlGenerators.

      • processMethodDoc

        void processMethodDoc​(MethodDoc methodDoc,
                      org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.MethodDocType methodDocType)
        Process the provided methodDoc and add your custom information to the methodDocType.
        Use e.g. MethodDocType.getAny() to store custom elements.
        Parameters:
        methodDoc - the MethodDoc representing the docs of your method.
        methodDocType - the related MethodDocType that will later be processed by the WadlGenerators.

      • processParamTag

        void processParamTag​(ParamTag paramTag,
                     Parameter parameter,
                     org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ParamDocType paramDocType)
        Use this method to extend the provided ParamDocType with the information from the given ParamTag and Parameter.
        Parameters:
        paramTag - the parameter javadoc
        parameter - the parameter (that is documented or not)
        paramDocType - the ParamDocType to extend. This will later be processed by the WadlGenerators.