Class PackageSummary


  • public class PackageSummary
    extends java.lang.Object
    Java Doc HTML-File Reader: Find and retrieve any of the parts of Java Doc Package-Summary HTML-File.

    This class parses the 'package-summary.html' files that are generated by the Java Doc Tool. These pages are only modified if the user has requested to re-arrange the list of classes, interfaces etc... that are placed on the page. The rearanging is done by the class RearrangePkgFrame.


Stateless Class: This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member field. It is very similar to the Java-Bean @Stateless Annotation.
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 10 Method(s), 10 declared static
  • 0 Field(s)


    • Method Detail

      • iterator

        🡇    
        public static HNLIInclusive iterator​(java.util.Vector<HTMLNode> fileVec)
        This returns an Iterator for all of the table-rows in a "Package Summary" web-page generated by Java-Doc.
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        Iterates all entires in all tables of this package-summary.
        Throws:
        java.lang.IllegalArgumentException
        Code:
        Exact Method Body:
         DotPair main = listAll(fileVec);
        
         if (main == null) throw new IllegalArgumentException(
             "The HTML Vector provided to parameter 'fileVec' did not have a " +
             "<UL CLASS='blockList'> element.  fileVec.size(): [" + fileVec.size() + "], " +
             "has " + TagNodeCount.all(fileVec, TC.OpeningTags, "ul") + " total <UL> element(s)."
         );
        
         HNLIInclusive iter = InnerTagInclusiveIterator.get
             (fileVec, "tr", "class", TextComparitor.C_OR, "rowColor", "altColor");
        
         iter.restrictCursor(main);
        
         return iter;
        
      • fillCIETList

        🡅  🡇    
        public static void fillCIETList​
                    (java.util.Vector<HTMLNode> fileVec,
                     java.util.TreeSet<java.lang.String> packageCIETList)
        
        Retrieves a list of all CIET Names in a Java Doc 'package-summary.html' page. This is, essentialy, all of the DOCUMENTED Types / CIET's in a given Java Package. The String's are saved into the provided TreeSet<String> parameter, and these names only include class-name itself, without the full-package name being appended.
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        packageCIETList - This should be a reference to an empty TreeSet<String>. This reference will be filled with all the Type-Names (CIET-Names) listed on this Package Summary Page.
        Code:
        Exact Method Body:
         // Iterates the <TR>'s (Table-Row HTML Inclusive Iterator) - IN ALL TABLES of the input
         // 'package-summary.html' file.  This method is defined above, in this class.
        
         HNLIInclusive iter = PackageSummary.iterator(fileVec);
        
         while (iter.hasNext())
         {
             Vector<HTMLNode>    cieteeVec   = iter.next();
             int                 pos         = TagNodeFind.first(cieteeVec, TC.OpeningTags, "a");
        
             // Simply add it to the TreeSet
             packageCIETList.add(cieteeVec.elementAt(pos + 1).str);
         }
        
      • listAll

        🡅  🡇    
        public static DotPair listAll​(java.util.Vector<HTMLNode> fileVec)
        Retrieves the primary surrounding <UL> element that lists of all of the entites (classes, interfaces, etc...) that are contained by the package provided to this method.

        HTML Elements:
         <ul class="blockList">
           <li class="blockList">
           <!-- Contains 'Type Summary' HTML Tables -->
        
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        The complete-list of all classes, interfaces, enums, errors, exceptions and annotations - as an instance of DotPair
        Code:
        Exact Method Body:
         return InnerTagFindInclusive.first
             (fileVec, "ul", "class", TextComparitor.C, "blockList");
        
      • interfaces

        🡅  🡇    
        public static DotPair interfaces​(java.util.Vector<HTMLNode> fileVec)
        Returns an instance of DotPair which points to an HTML <TABLE> element, where that table has CLASS=typeSummary and contains a caption with the text Interface Summary.

        HTML Elements:
         <li class="blockList">
          <table class="typeSummary">
          <caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
          <tr>
         ...
        
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        The "Interface Summary" section of the "Package Summary", or null if the package-summary page provided did not have an "Interface Summary" section
        Code:
        Exact Method Body:
         return typeSummary(fileVec, "Interface Summary");
        
      • classes

        🡅  🡇    
        public static DotPair classes​(java.util.Vector<HTMLNode> fileVec)
        Returns an instance of DotPair which points to an HTML <TABLE> element, where that table has CLASS=typeSummary and contains a caption with the text Class Summary.

        HTML Elements:
         <li class="blockList">
          <table class="typeSummary">
          <caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
          <tr>
         ...
        
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        The "Class Summary" section of the "Package Summary", or null if the package-summary page provided did not have an "Class Summary" section
        Code:
        Exact Method Body:
         return typeSummary(fileVec, "Class Summary");
        
      • enums

        🡅  🡇    
        public static DotPair enums​(java.util.Vector<HTMLNode> fileVec)
        Returns an instance of DotPair which points to an HTML <TABLE> element, where that table has CLASS=typeSummary and contains a caption with the text Enum Summary.

        HTML Elements:
         <li class="blockList">
          <table class="typeSummary">
          <caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
          <tr>
         ...
        
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        The "Enum Summary" section of the "Package Summary", or null if the package-summary page provided did not have an "Enum Summary" section
        Code:
        Exact Method Body:
         return typeSummary(fileVec, "Enum Summary");
        
      • exceptions

        🡅  🡇    
        public static DotPair exceptions​(java.util.Vector<HTMLNode> fileVec)
        Returns an instance of DotPair which points to an HTML <TABLE> element, where that table has CLASS=typeSummary and contains a caption with the text Exception Summary.

        HTML Elements:
         <li class="blockList">
          <table class="typeSummary">
          <caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
          <tr>
         ...
        
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        The "Exception Summary" section of the "Package Summary", or null if the package-summary page provided did not have an "Exception Summary" section
        Code:
        Exact Method Body:
         return typeSummary(fileVec, "Exception Summary");
        
      • errors

        🡅  🡇    
        public static DotPair errors​(java.util.Vector<HTMLNode> fileVec)
        Returns an instance of DotPair which points to an HTML <TABLE> element, where that table has CLASS=typeSummary and contains a caption with the text Error Summary.

        HTML Elements:
         <li class="blockList">
          <table class="typeSummary">
          <caption><span>Error Summary</span><span class="tabEnd">&nbsp;</span></caption>
          <tr>
         ...
        
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        The "Error Summary" section of the "Package Summary", or null if the package-summary page provided did not have an "Error Summary" section
        Code:
        Exact Method Body:
         return typeSummary(fileVec, "Error Summary");
        
      • annotations

        🡅    
        public static DotPair annotations​(java.util.Vector<HTMLNode> fileVec)
        Returns an instance of DotPair which points to an HTML <TABLE> element, where that table has CLASS=typeSummary and contains a caption with the text Annotation Types Summary.

        HTML Elements:
         <li class="blockList">
          <table class="typeSummary">
          <caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
          <tr>
         ...
        
        Parameters:
        fileVec - The vectorized-HTML for a Java Doc Generated "Package Summary" Web-Page.
        Returns:
        The "Annotation Types Summary" section of the "Package Summary", or null if the package-summary page provided did not have an "Error Summary" section
        Code:
        Exact Method Body:
         return typeSummary(fileVec, "Annotation Types Summary");