Class DetailsPartField


  • public class DetailsPartField
    extends java.lang.Object
    JavaDoc Details-Part Field - Documentation.

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

    • Field Name (always the same, i.e. the name of the class)
    • Field Signature
    • Field Description
    • 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
  • 5 Method(s), 5 declared static
  • 0 Field(s)


    • Method Detail

      • name

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

        This retrieves the field name vectorized-HTML.

        HTML Elements:
        1
        2
         <h4> [Field Name] </h4>
         
        
        Parameters:
        javaDocFieldHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Field in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Field Details').
        Returns:
        DotPair pointing to HTML for the 'Field Name' part.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Field Details' section, retrieved via Details.fieldDetailsIterator(). 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.fieldDetailsIterator(Vector)
        Code:
        Exact Method Body:
        1
        2
         DetailsException.check(javaDocFieldHTML);
         return TagNodeFindInclusive.first(javaDocFieldHTML, "h4");
        
      • signature

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

        This retrieves the field signature vectorized-HTML.

        HTML Elements:
        1
        2
        3
         <h4> [Field Name] </h4>
         <pre> ... </pre>
         
        
        Parameters:
        javaDocFieldHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Field in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Field Details').
        Returns:
        DotPair pointing to HTML for the 'Field Signature' part.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Field Details' section, retrieved via Details.fieldDetailsIterator(). 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.fieldDetailsIterator(Vector)
        Code:
        Exact Method Body:
        1
        2
         DetailsException.check(javaDocFieldHTML);
         return TagNodeFindInclusive.first(javaDocFieldHTML, "pre");
        
      • description

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

        This retrieves the field description vectorized-HTML.

        HTML Elements:
        1
        2
         <div class="block"> ... [Textual Description of Field] ... </div>
         
        
        Parameters:
        javaDocFieldHTML - This should be the HTML sub-section of a JavaDoc '.html' page which describes the functionality of a single Field in a java class. It can be retrieved by a call to HNLIIterator.next() (after retrieving the HTML Inclusive Iterator for 'Field Details').
        Returns:
        DotPair pointing to HTML for the 'Field Description' part.
        Throws:
        DetailsException - This does a quick check on each invocation to ensure that the vectorized-HTML parameter is actually a 'Field Details' section, retrieved via Details.fieldDetailsIterator(). 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.fieldDetailsIterator(Vector)
        Code:
        Exact Method Body:
        1
        2
        3
         DetailsException.check(javaDocFieldHTML);
         return InnerTagFindInclusive.first
             (javaDocFieldHTML, "div", "class", TextComparitor.C, "block");
        
      • see

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

        This retrieves the field see also vectorized-HTML.

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

        Null will be returned if this HTML class description page for the Field 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 'Field Details' section, retrieved via Details.fieldDetailsIterator(). 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(javaDocFieldHTML, "seeLabel");
        
      • overrideSpecify

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

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

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

        Null will be returned if this HTML class description page for the Field 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 'Field Details' section, retrieved via Details.fieldDetailsIterator(). 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(javaDocFieldHTML, "overrideSpecifyLabel");