Class SummaryTableHTML<ENTITY extends Declaration>


  • public class SummaryTableHTML<ENTITY extends Declaration>
    extends java.lang.Object
    This class stores the HTML for a Summary-Table - which is the table at the top of a Java Doc Page listing all of one type of entities present in the CIET/Type. There are several possible Summary-Tables, inclusive of:

    • Method Summaries
    • Field Summaries
    • Constructor Summaries
    • Enum Constant Summaries
    • Optional Annotation Element Summaries
    • Requires Annotation Element Summaries
    • Inner-Class Summaries
    See Also:
    Summaries


    • Field Detail

      • serialVersionUID

        🡇    
        protected static final long serialVersionUID
        This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        protected static final long serialVersionUID = 1;
        
      • tableType

        🡅  🡇    
        public final Entity tableType
        Indicates what type of Summary-Table this is (Methods, Fields, Constructor's, etc).
        Code:
        Exact Field Declaration Expression:
        public final Entity tableType;
        
      • tableOpen

        🡅  🡇    
        public final TagNodeIndex tableOpen
        The opening <TABLE> tag, for a Summary-Section Table
        Code:
        Exact Field Declaration Expression:
        public final TagNodeIndex tableOpen;
        
      • tableClose

        🡅  🡇    
        public final TagNodeIndex tableClose
        The closing </TABLE> tag, for a Summary-Section Table
        Code:
        Exact Field Declaration Expression:
        public final TagNodeIndex tableClose;
        
    • Method Detail

      • getTableRow

        🡅  🡇    
        public java.util.Vector<HTMLNodegetTableRow​(int i)
        Retrieve the ith HTML <TR> (row) from this Summary-Table
        Parameters:
        i - The row number to retrieve
        Returns:
        All HTML between the <TR> and the </TR> for one table-summary row.
        Throws:
        java.lang.IndexOutOfBoundsException - If i is not within the bounds of the list of rows
        Code:
        Exact Method Body:
         return tableRows.elementAt(i);
        
      • getRowEntity

        🡅  🡇    
        public ENTITY getRowEntity​(int i)
        Retrieve the ith entity. The returned instance will be one of the six subclasses of class Declaration, as decided by the type-parameter ENTITY.
        Parameters:
        i - The entity-number (row-number) to retrieve from this Summary-Table.
        Returns:
        The refected-information for one Summary-Table row.
        Throws:
        java.lang.IndexOutOfBoundsException - If i is not within the bounds of the list of rows
        Code:
        Exact Method Body:
         return rowEntities.elementAt(i);
        
      • getEntityAndRow

        🡅  🡇    
        public Ret2<ENTITY,​java.util.Vector<HTMLNode>> getEntityAndRow​(int i)
        Retrieve both the row-HTML and the reflected-entity information for the ith row in this Summary-Table
        Parameters:
        i - The entity-number / row-number to retrieve from this Summary-Table.
        Returns:
        An instance of Ret2:

        • Ret2.a, of type 'ENTITY' (this class sole type-parameter)

        • Ret2.b, of type Vector<HTMLNode>
        Throws:
        java.lang.IndexOutOfBoundsException - If i is not within the bounds of the list of rows
        Code:
        Exact Method Body:
         return new Ret2<>(rowEntities.elementAt(i), tableRows.elementAt(i));
        
      • tableRowIterator

        🡅  🡇    
        public java.util.Iterator<java.util.Vector<HTMLNode>> tableRowIterator()
        An Iterator that iterates this Summary-Table's rows, as Vectorized-HTML
        Returns:
        An iterator of HTML-Rows for this instance of the Summary-Table.
        Code:
        Exact Method Body:
         return new RemoveUnsupportedIterator<>(tableRows.iterator());
        
      • tableRowStream

        🡅  🡇    
        public java.util.stream.Stream<java.util.Vector<HTMLNode>> tableRowStream()
        A Stream that contains this Summary-Table's rows, as Vectorized-HTML
        Returns:
        A stream of HTML-Rows for this Summary-Table.
        Code:
        Exact Method Body:
         return tableRows.stream();
        
      • rowEntityIterator

        🡅  🡇    
        public java.util.Iterator<ENTITYrowEntityIterator()
        An Iterator that iterates this Summary-Table's rows, as instances of the reflected information class ENTITY (this class' sole type-parameter). This includes Method, Field, Constructor and NestedType etc...
        Returns:
        An iterator of entities contained by this Summary-Table.
        Code:
        Exact Method Body:
         return new RemoveUnsupportedIterator<>(rowEntities.iterator());
        
      • rowEntityStream

        🡅  🡇    
        public java.util.stream.Stream<ENTITYrowEntityStream()
        A Stream that contains all Summary-Table row-entities, as instances of the reflected information class ENTITY (this class' sole type-parameter).
        Remember, that ENTITY, a Generic Type-Parameter, will be one of the six concrete subclasses of class Declaration. This includes Method, Field, Constructor and NestedType etc...
        Returns:
        A stream of entities contained by this Summary-Table.
        Code:
        Exact Method Body:
         return rowEntities.stream();
        
      • getEntityAndRowVector

        🡅    
        public java.util.Vector<Ret2<ENTITY,​java.util.Vector<HTMLNode>>> getEntityAndRowVector
                    ()
        
        Retrieve a Vector that contains every Summary-Table row. The specific contents of this Vector are instances of Ret2, which contain both the reflected-entity information (instance of type-parameter ENTITY) and the Vectorized-HTML for the table-row, as well.
        Returns:
        A Vector containing instances of Ret2:

        • Ret2.a, of type 'ENTITY' (this class sole type-parameter)

        • Ret2.b, of type Vector<HTMLNode>
        Code:
        Exact Method Body:
         Vector<Ret2<ENTITY, Vector<HTMLNode>>> ret = new Vector<>(rowEntities.size());
        
         for (int i=0; i < tableRows.size(); i++)
             ret.add(new Ret2<>(rowEntities.elementAt(i), tableRows.elementAt(i)));
        
         return ret;