Class CommentNodeFind


  • public class CommentNodeFind
    extends java.lang.Object
    CommentNode Find - Documentation.

    CommentNodeFind =>

    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. Find: This implies that integer values are returned by these methods. These integers are intended to serve as pointers into the underlying input Java Vector.

    Methods Available

    Method Explanation
    first (...) This will retrieve an integer-pointer to the first CommentNode match found in the vectorized-page parameter 'html'.
    nth (...) This will retrieve an integer-pointer to the nth CommentNode match found in the vectorized-page parameter 'html'.
    last (...) This will retrieve an integer-pointer to the last CommentNode match found in the vectorized-page parameter 'html'.
    nthFromEnd (...) This will retrieve an integer-pointer to the nth-from-last CommentNode match found in the vectorized-page parameter 'html'.
    all (...) This will retrieve an integer-pointer to every CommentNode found in the vectorized-page parameter 'html' that matches the specified search-criteria.
    allExcept (...) This will retrieve an integer-pointer to every 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.
    int nth This represents the 'nth' match of a comparison for-loop. When the method-signature used includes the parameter 'nth' , the first n-1 matches that are found - will be skipped, and the 'nth' match is, instead, returned.

    EXCEPTIONS: An NException shall throw if the value of parameter 'nth' is zero, negative, or larger than the size of the input html-Vector.
    int sPos, int ePos When these parameters are present, only HTMLNode's that are found between the specified Vector indices will be considered for matching with the search criteria.

    NOTE: In every situation where the parameters int sPos, int ePos are used, parameter 'ePos' will accept a negative value, but parameter 'sPos' will not. When 'ePos' is passed a negative-value, the internal LV ('Loop Variable Counter') will have its public final int end field set to the length of the vectorized-html page that was passed. (html.size() of parameter Vector<HTMLNode> html).

    EXCEPTIONS: An IndexOutOfBoundsException will be thrown if:

    • If sPos is negative, or if sPos is greater-than or equal-to the size of the input Vector
    • If ePos is zero, or greater than the size of the input Vector.
    • If sPos is a larger integer than ePos
    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. int represents a position in the html vectorized-page parameter 'html'
    2. A return value of -1 implies no matches were found.
    3. int[] - An array of integers represent a list of indexes into the vectorized-page parameter 'html', with each integer being a different position in the vector that has a matching CommentNode
    4. A zero-length int[] array means no matches were found on the page or sub-page. Zero-length arrays are returned from any method where the possibility existed for multiple-matches being provided as a result-set.


    View Actual Hi-Lited Code Files:







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
  • 36 Method(s), 36 declared static
  • 0 Field(s)


    • Method Summary

       
      First Match
      Search Specifier Modifier and Type Method
      String-Predicate static int first​(Vector<? extends HTMLNode> html, Predicate<String> p)
      Regular-Expression static int first​(Vector<? extends HTMLNode> html, Pattern p)
      Text-Comparitor static int first​(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
       
      First Match, Range Limited
      Search Specifier Modifier and Type Method
      String-Predicate static int first​(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
      Regular-Expression static int first​(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
      Text-Comparitor static int first​(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
       
      Last Match
      Search Specifier Modifier and Type Method
      String-Predicate static int last​(Vector<? extends HTMLNode> html, Predicate<String> p)
      Regular-Expression static int last​(Vector<? extends HTMLNode> html, Pattern p)
      Text-Comparitor static int last​(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
       
      Last Match, Range Limited
      Search Specifier Modifier and Type Method
      String-Predicate static int last​(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
      Regular-Expression static int last​(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
      Text-Comparitor static int last​(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
       
      Nth Match
      Search Specifier Modifier and Type Method
      String-Predicate static int nth​(Vector<? extends HTMLNode> html, int nth, Predicate<String> p)
      Regular-Expression static int nth​(Vector<? extends HTMLNode> html, int nth, Pattern p)
      Text-Comparitor static int nth​(Vector<? extends HTMLNode> html, int nth, TextComparitor tc, String... compareStr)
       
      Nth Match, Range Limited
      Search Specifier Modifier and Type Method
      String-Predicate static int nth​(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Predicate<String> p)
      Regular-Expression static int nth​(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Pattern p)
      Text-Comparitor static int nth​(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, TextComparitor tc, String... compareStr)
       
      Nth Match From End
      Search Specifier Modifier and Type Method
      String-Predicate static int nthFromEnd​(Vector<? extends HTMLNode> html, int nth, Predicate<String> p)
      Regular-Expression static int nthFromEnd​(Vector<? extends HTMLNode> html, int nth, Pattern p)
      Text-Comparitor static int nthFromEnd​(Vector<? extends HTMLNode> html, int nth, TextComparitor tc, String... compareStr)
       
      Nth Match From End, Range Limited
      Search Specifier Modifier and Type Method
      String-Predicate static int nthFromEnd​(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Predicate<String> p)
      Regular-Expression static int nthFromEnd​(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Pattern p)
      Text-Comparitor static int nthFromEnd​(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, TextComparitor tc, String... compareStr)
       
      All Matches
      Search Specifier Modifier and Type Method
      String-Predicate static int[] all​(Vector<? extends HTMLNode> html, Predicate<String> p)
      Regular-Expression static int[] all​(Vector<? extends HTMLNode> html, Pattern p)
      Text-Comparitor static int[] all​(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
       
      All Matches, Range Limited
      Search Specifier Modifier and Type Method
      String-Predicate static int[] all​(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
      Regular-Expression static int[] all​(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
      Text-Comparitor static int[] all​(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
       
      All Non-Matches
      Search Specifier Modifier and Type Method
      String-Predicate static int[] allExcept​(Vector<? extends HTMLNode> html, Predicate<String> p)
      Regular-Expression static int[] allExcept​(Vector<? extends HTMLNode> html, Pattern p)
      Text-Comparitor static int[] allExcept​(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
       
      All Non-Matches, Range Limited
      Search Specifier Modifier and Type Method
      String-Predicate static int[] allExcept​(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
      Regular-Expression static int[] allExcept​(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
      Text-Comparitor static int[] allExcept​(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait