Class CommentNodeIterator


  • public class CommentNodeIterator
    extends java.lang.Object
    CommentNode Iterator - Documentation.

    CommentNodeIterator =>

    1. CommentNode: This implies that TagNode and TextNode elements are ignored completely in this search, and instead, the "comments" between the <!-- and --> symbols - which are all instances of CommentNode, are searched.
    2. Iterator: This means that java Iterator's (extension of java.util.ListIterator<E>) are returned, rather than simple-results or vectors of results. Iterator's make updating a Vector<HTMLNode> much easier (by avoiding the problems caused by stale index-pointers), and usually simply many of the retrieval & removal operations when large HTML TABLE and UL / OL are involved.

    Methods Available

    Method Explanation
    iterator (...) The returns an HNLI<CommentNode> that will iterate through each CommentNode found in the vectorized-page parameter 'html' that matches the specified search-criteria.
    exceptIterator (...) The returns an HNLI<CommentNode> that will iterate through each CommentNode found in the vectorized-page parameter 'html' that does not match the specified search-criteria.

    Method Parameters

    Parameter Explanation
    Vector<? extends HTMLNode> html This represents any vectorized HTML page, sub-page, or list of partial-elements.
    TextComparitor tc WORKS WITH: This parameter utilizes / works-with parameter String... compareStr to perform the requested comparisons. The comparisons are computed using the String 'body' field of a CommentNode.

    When this parameter is present in the method-signature parameter-list, the decision of whether a CommentNode is to be included in the search result-set is defined by this parameter's FunctionalInterface Predicate 'test' method. TextComparitor is a Java BiPredicate<String, String[]> which compares its first String-parameter against the String's in its second.
    Pattern p These parameters reference Java's "Regular Expression" processing engine. If the method-signature includes the java.util.regex.Pattern parameter, the search-loops will use the standard Regular-Expression Pattern matching routine: p.matcher(comment_node.body).find() when deciding which CommentNode's "match" this search-criteria.
    Predicate<String> p When this parameter is present in the method-signature parameter-list, the decision of whether a CommentNode is to be included in the search result-set are made by the results of the Java Predicate.test(String) method.

    Specifically: p.test(comment_node.body)
    String... compareStr WORKS WITH: This parameter works in coordination with the TextComparitor tc parameter. This parameter supplies the String's with which the comparisons of the CommentNode.body field may be compared.

    Return Values:

    1. HNLI<CommentNode> which returns, one-at-a-time, CommentNode's out of the vectorized-HTML page parameter 'html' which matched.


    Static (Functional) API: The methods in this class are all (100%) defined with the Java Key-Word / Key-Concept 'static'. Furthermore, there is no way to obtain an instance of this class, because there are no public (nor private) constructors. Java's Spring-Boot, MVC feature is *not* utilized because it flies directly in the face of the light-weight data-classes philosophy. This has many advantages over the rather ornate Component Annotations (@Component, @Service, @AutoWired, etc... 'Java Beans') syntax:

    • The methods here use the key-word 'static' which means (by implication) that there is no internal-state. Without any 'internal state' there is no need for constructors in the first place! (This is often the complaint by MVC Programmers).
    • A 'Static' (Functional-Programming) API expects to use fewer data-classes, and light-weight data-classes, making it easier to understand and to program.
    • The Vectorized HTML data-model allows more user-control over HTML parse, search, update & scrape. Also, memory management, memory leakage, and the Java Garbage Collector ought to be intelligible through the 'reuse' of the standard JDK class Vector for storing HTML Web-Page data.

    The power that object-oriented programming extends to a user is (mostly) limited to data-representation. Thinking of "Services" as "Objects" (Spring-MVC, 'Java Beans') is somewhat 'over-applying' the Object Oriented Programming Model. Like most classes in the Java-HTML JAR Library, this class backtracks to a more C-Styled Functional Programming Model (no Objects) - by re-using (quite profusely) the key-word static with all of its methods, and by sticking to Java's well-understood class Vector

    Internal-State: A user may click on this class' source code (see link below) to view any and all internally defined fields class. A cursory inspection of the code would prove that this class has precisely zero internally defined global fields (Spaghetti). All variables used by the methods in this class are local fields only, and therefore this class ought to be though of as 'state-less'.

    NOTE: Although this class is 'stateless' (has no internally defined fields at all, the Iterator's that are returned do, indeed, have stateful variables.

    View Actual Hi-Lited Code Files: