java.lang.Object
- Torello.HTML.NodeSearch.CommentNodePoll

public class CommentNodePoll
extends java.lang.Object

CommentNodePoll 🠞

CommentNode: This implies that TagNode and TextNode elements are ignored completely in this search, and instead, the "comments" between the  symbols - which are all instances of CommentNode, are searched.
Poll: This refers to the operation of both removing and returning node matches to the programmer. After a 'poll' operation, the initial vectorized-html will actually contain fewer elements - and the removed elements shall be returned to the calling method.

Searches for, and extracts, HTML Comments from Vectorized-HTML that match a user-specified search-criteria, and returns those extracted node or nodes.

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.asPredicate().test(comment_node.body)` 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:

CommentNode represents a matched CommentNode from the html vectorized-page parameter 'html' - after having been removed from the underlying vector, first
A return value of null implies no matches were found.
Vector<CommentNode> - A vector of CommentNode represent all matches from the vectorized-page parameter 'html' - all of which were also removed from the underlying vector.
A zero-length Vector<CommentNode> means no matches were found on the page or sub-page. Empty Vectors are returned from any method where the possibility existed for multiple-matches being provided as a result-set.

Hi-Lited Source-Code:

This File's Source Code:

View Here: Torello/HTML/NodeSearch/CommentNodePoll.java
Open New Browser-Tab: Torello/HTML/NodeSearch/CommentNodePoll.java

File Size: 9,019 Bytes Line Count: 131 '\n' Characters Found
Actual Search Loop Class:

View Here: SearchLoops/CommentNodes/CmtNPoll.java
Open New Browser-Tab: SearchLoops/CommentNodes/CmtNPoll.java

File Size: 2,281 Bytes Line Count: 82 '\n' Characters Found
Argument Checker Class:

View Here: ARGCHECK.java
Open New Browser-Tab: ARGCHECK.java

File Size: 17,874 Bytes Line Count: 425 '\n' Characters Found

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 fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.

1 Constructor(s), 1 declared private, zero-argument constructor
36 Method(s), 36 declared static
0 Field(s)

Method Summary

All Matches

Modifier and Type	Method
`static Vector<CommentNode>`	`all(Vector<? extends HTMLNode> html, Predicate<String> p)`
`static Vector<CommentNode>`	`all(Vector<? extends HTMLNode> html, Pattern p)`
`static Vector<CommentNode>`	`all(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)`

All Matches, Range Limited
Modifier and Type	Method
`static Vector<CommentNode>`	`all(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)`
`static Vector<CommentNode>`	`all(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)`
`static Vector<CommentNode>`	`all(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)`

All Non-Matches
Modifier and Type	Method
`static Vector<CommentNode>`	`allExcept(Vector<? extends HTMLNode> html, Predicate<String> p)`
`static Vector<CommentNode>`	`allExcept(Vector<? extends HTMLNode> html, Pattern p)`
`static Vector<CommentNode>`	`allExcept(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)`

All Non-Matches, Range Limited
Modifier and Type	Method
`static Vector<CommentNode>`	`allExcept(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)`
`static Vector<CommentNode>`	`allExcept(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)`
`static Vector<CommentNode>`	`allExcept(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)`

First Match
Modifier and Type	Method
`static CommentNode`	`first(Vector<? extends HTMLNode> html, Predicate<String> p)`
`static CommentNode`	`first(Vector<? extends HTMLNode> html, Pattern p)`
`static CommentNode`	`first(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)`

First Match, Range Limited
Modifier and Type	Method
`static CommentNode`	`first(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)`
`static CommentNode`	`first(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)`
`static CommentNode`	`first(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)`

Last Match
Modifier and Type	Method
`static CommentNode`	`last(Vector<? extends HTMLNode> html, Predicate<String> p)`
`static CommentNode`	`last(Vector<? extends HTMLNode> html, Pattern p)`
`static CommentNode`	`last(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)`

Last Match, Range Limited
Modifier and Type	Method
`static CommentNode`	`last(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)`
`static CommentNode`	`last(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)`
`static CommentNode`	`last(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)`

Nth Match
Modifier and Type	Method
`static CommentNode`	`nth(Vector<? extends HTMLNode> html, int nth, Predicate<String> p)`
`static CommentNode`	`nth(Vector<? extends HTMLNode> html, int nth, Pattern p)`
`static CommentNode`	`nth(Vector<? extends HTMLNode> html, int nth, TextComparitor tc, String... compareStr)`

Nth Match, Range Limited
Modifier and Type	Method
`static CommentNode`	`nth(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Predicate<String> p)`
`static CommentNode`	`nth(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Pattern p)`
`static CommentNode`	`nth(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, TextComparitor tc, String... compareStr)`

Nth Match From End
Modifier and Type	Method
`static CommentNode`	`nthFromEnd(Vector<? extends HTMLNode> html, int nth, Predicate<String> p)`
`static CommentNode`	`nthFromEnd(Vector<? extends HTMLNode> html, int nth, Pattern p)`
`static CommentNode`	`nthFromEnd(Vector<? extends HTMLNode> html, int nth, TextComparitor tc, String... compareStr)`

Nth Match From End, Range Limited
Modifier and Type	Method
`static CommentNode`	`nthFromEnd(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Predicate<String> p)`
`static CommentNode`	`nthFromEnd(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Pattern p)`
`static CommentNode`	`nthFromEnd(Vector<? extends HTMLNode> html, int nth, 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

Class CommentNodePoll

Methods Available

Method Parameters

Return Values:

Method Summary

Methods inherited from class java.lang.Object