Class DetailsPartMethod


  • public class DetailsPartMethod
    extends java.lang.Object
    JavaDoc Details-Part Method - Documentation.

    This will scour and retrieve the parts of a vectorized-HTML Java Class Documentation Method Definition for it's various sub-parts. Each JavaDoc generated HTML Page 'Method' details contains some or all of the following sections:

    • Method Name
    • Method Signature
    • Method Description
    • Method Parameter Descriptions
    • Method Return Description
    • Method Throws Types and Explanations
    • A 'see further' list of links

    The methods in this class will return the subsection as a DotPair pointer-pair, and it shall return null if this section was not found. These methods will throw an DetailsException if passed an invalid Method-HTML-Description part.

    USES, BENEFITS: Primarily, the three classes: DetailsPartConstructor, DetailsPartMethod and DetailsPartField is to help the user avoid trolling through the HTML-Source output of the JavaDoc utility. Having already done that, providing a simple method that can return an index-pointer (vector-location) to the entry or item in a standard JavaDoc Output Page - one could easily automate a build script to insert nicer, pretty-printed HTML-based explanations to further improve their code's documentation.




Stateless Class: This class neither contains any program-state, nor can it be instantiated.
The @StaticFunctional Annotation may also be called 'The Spaghetti Report'
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 8 Method(s), 8 declared static
  • 0 Field(s)


    • Method Detail

      • name

        public static DotPair name​(java.util.Vector<HTMLNode> javaDocMethodHTML)
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method name vectorized-HTML.

        HTML Elements:
        1
        2
         <h4> [Method Name] </h4>
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method Name' part.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        DetailsException, TagNodeFindInclusive, Details.methodDetailsIterator(Vector)
        Code:
        Exact Method Body:
        1
        2
         DetailsException.check(javaDocMethodHTML);
         return TagNodeFindInclusive.first(javaDocMethodHTML, "h4");
        
      • signature

        public static DotPair signature​
                    (java.util.Vector<HTMLNode> javaDocMethodHTML)
        
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method signature vectorized-HTML.

        HTML Elements:
        1
        2
        3
         <h4> [Method Name] </h4>
         <pre class="methodSignature"> ... </pre>
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method Signature' part.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        DetailsException, TagNodeFindInclusive, Details.methodDetailsIterator(Vector)
        Code:
        Exact Method Body:
        1
        2
         DetailsException.check(javaDocMethodHTML);
         return TagNodeFindInclusive.first(javaDocMethodHTML, "pre");
        
      • description

        public static DotPair description​
                    (java.util.Vector<HTMLNode> javaDocMethodHTML)
        
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method description vectorized-HTML.

        HTML Elements:
        1
        2
         <div class="block"> ... [Textual Description of Method] ... </div>
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method Description' part.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        DetailsException, InnerTagFindInclusive, Details.methodDetailsIterator(Vector)
        Code:
        Exact Method Body:
        1
        2
        3
         DetailsException.check(javaDocMethodHTML);
         return InnerTagFindInclusive.first
             (javaDocMethodHTML, "div", "class", TextComparitor.C, "block");
        
      • parameters

        public static DotPair parameters​
                    (java.util.Vector<HTMLNode> javaDocMethodHTML)
        
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method parameters vectorized-HTML.

        HTML Elements:
        1
        2
        3
         <dt><span class="paramLabel">Parameters:</span></dt>
         <dd>...
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method Parameters' part.

        Null will be returned if this HTML class description page for the Method that is passed does not contain a 'parameters' section.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        HELPER.getSpanSection(Vector, String)
        Code:
        Exact Method Body:
        1
         return HELPER.getSpanSection(javaDocMethodHTML, "paramLabel");
        
      • returns

        public static DotPair returns​
                    (java.util.Vector<HTMLNode> javaDocMethodHTML)
        
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method return vectorized-HTML.

        HTML Elements:
        1
        2
        3
         <dt><span class="returnLabel">Returns:</span></dt>
         <dd>...
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method Returns' part.

        Null will be returned if this HTML class description page for the Method that is passed does not contain a 'returns' section.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        HELPER.getSpanSection(Vector, String)
        Code:
        Exact Method Body:
        1
         return HELPER.getSpanSection(javaDocMethodHTML, "returnLabel");
        
      • throwing

        public static DotPair throwing​
                    (java.util.Vector<HTMLNode> javaDocMethodHTML)
        
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method throws vectorized-HTML.

        HTML Elements:
        1
        2
        3
         <dt><span class="throwsLabel">Throws:</span></dt>
         <dd>...
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method Throws' part.

        Null will be returned if this HTML class description page for the Method that is passed does not contain a 'throws' section.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        HELPER.getSpanSection(Vector, String)
        Code:
        Exact Method Body:
        1
         return HELPER.getSpanSection(javaDocMethodHTML, "throwsLabel");
        
      • see

        public static DotPair see​(java.util.Vector<HTMLNode> javaDocMethodHTML)
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method see also vectorized-HTML.

        HTML Elements:
        1
        2
        3
         <dt><span class="seeLabel">See Also:</span></dt>
         <dd>...
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method See Also' part.

        Null will be returned if this HTML class description page for the Method that is passed does not contain a 'see also' section.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        HELPER.getSpanSection(Vector, String)
        Code:
        Exact Method Body:
        1
         return HELPER.getSpanSection(javaDocMethodHTML, "seeLabel");
        
      • overrideSpecify

        public static DotPair overrideSpecify​
                    (java.util.Vector<HTMLNode> javaDocMethodHTML)
        
        This method should be used in conjunction with Details.methodDetailsIterator(javaDocPage);. The Iterator returned by that method will retrieve JavaDoc entries for the 'Method Details' in a JavaDoc generated vectorized-HTML web-page.

        This retrieves the method "Specified by" vectorized-HTML.

        HTML Elements:
        1
        2
        3
         <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
         <dd>...
         
        
        Parameters:
        javaDocMethodHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Method in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Method Details').
        Returns:
        DotPair pointing to HTML for the 'Method Specified By' part.

        Null will be returned if this HTML class description page for the Method that is passed does not contain a 'specified by' section.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Method Details' section, retrieved via Details.methodDetailsIterator(). The section may also be obtained manually (without using the Iterator), but the programmer must ensure the HTML start and end-points are the same as those returned by the Iterator.
        See Also:
        HELPER.getSpanSection(Vector, String)
        Code:
        Exact Method Body:
        1
         return HELPER.getSpanSection(javaDocMethodHTML, "overrideSpecifyLabel");