Class PackageSummary

  • public class PackageSummary
extends java.lang.Object
    JavaDoc PackageSummary - Documentation.

    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'
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 9 Method(s), 9 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.
        Code:
        Exact Method Body:
        1
2
3
4
5
6
7
8
         DotPair main = listAll(fileVec);

 HNLIInclusive iter = InnerTagInclusiveIterator.get
     (fileVec, "tr", "class", TextComparitor.C_OR, "rowColor", "altColor");

 iter.restrictCursor(main);

 return iter;

      • 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:
        1
2
3
4
         <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:
        1
2
         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:
        1
2
3
4
5
6
         <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:
        1
         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:
        1
2
3
4
5
6
         <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:
        1
         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:
        1
2
3
4
5
6
         <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:
        1
         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:
        1
2
3
4
5
6
         <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:
        1
         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:
        1
2
3
4
5
6
         <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:
        1
         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:
        1
2
3
4
5
6
         <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:
        1
         return typeSummary(fileVec, "Annotation Types Summary");