Serialized Form

Package javax.json

Class javax.json.JsonException extends java.lang.RuntimeException implements Serializable

Package javax.json.stream

Class javax.json.stream.JsonGenerationException extends JsonException implements Serializable

Class javax.json.stream.JsonParsingException extends JsonException implements Serializable

Serialized Fields

location

JsonLocation location

Package NeoVisionaries.WebSockets

Class NeoVisionaries.WebSockets.HostnameUnverifiedException extends WebSocketException implements Serializable

serialVersionUID:

1L

Serialized Fields

mHostname

java.lang.String mHostname

mSSLSocket

javax.net.ssl.SSLSocket mSSLSocket

Class NeoVisionaries.WebSockets.OpeningHandshakeException extends WebSocketException implements Serializable

serialVersionUID:

1L

Serialized Fields

mBody

byte[] mBody

mHeaders

java.util.Map<java.lang.String,java.util.List<java.lang.String>> mHeaders

mStatusLine

StatusLine mStatusLine

Class NeoVisionaries.WebSockets.WebSocketException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Serialized Fields

mError

WebSocketError mError

Package Torello.HTML

Class Torello.HTML.BalancedHTMLException extends MalformedHTMLException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.ClosingTagNodeException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.ClosingTagNodeExpectedException extends TagNodeExpectedException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.CommentNode extends HTMLNode implements Serializable

serialVersionUID:

1L

Serialized Fields

body

java.lang.String body

This stores a copy of the body of the comment. Specifically, (and simply) the java string method body = str.substring(4, str.length() - 3); is called and stored here. Yes, this does mean that extra memory / double memory is used to store comments, however the trade-offs are somewhat high.

TRADEOFFS: If the programmer or user ever wishes to perform a search, it becomes obvious that leaving off the beginning and trailing '<!--' and '-->' markers when specifying a search provides more easily readable code, and less error prone code. Thus, when using the CommentNodeFind, Get, Peek, Poll, etc... methods in the package NodeSearch, a Java String substring(...) would have to be invoked on every search comparison loop invocation. Primarily, keeping class HTMLNode and it's descendants all immutable is a much higher priority to ensure clean code, it becomes necessary to keep a redundant copy of the body String.

Class Torello.HTML.CommentNodeIndex extends NodeIndex<CommentNode> implements Serializable

serialVersionUID:

1L

Class Torello.HTML.DotPair extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

end

int end

This is intended to be the "ending index" into a sub-array of an HTML Vector of HTMLNode elements.

start

int start

This is intended to be the "starting index" into an sub-array of an HTML Vector of HTMLNode elements.

Class Torello.HTML.HREFException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.HTMLNode extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

str

java.lang.String str

This is an immutable field. It stores the complete contents of an HTML node. It can be either the "textual contents" of an HTML TagNode, or the text (directly) of the text-inside of an HTML page!

FOR INSTANCE:

• A subclass of HTMLNode - TagNode - could contain the String <SPAN STYLE="CSS INFO">" inside this str field here.
• The other sub-class of HTML - TextNode - could contain the String "This is a news-page from www.Gov.CN Chinese Government Portal." inside this str field here.

NOTE: Because sub-classes of HTMLNode are all immutable, generally, if you wish to change the contents of an HTML page, a programmer is required to create new nodes, rather than changing these fields.

Class Torello.HTML.HTMLTokException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.InnerTagKeyException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.InnerTagValueException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.MalformedHTMLException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Class Torello.HTML.MalformedTagNodeException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Serialized Fields

htmlElementStr

java.lang.String htmlElementStr

This public final field contains the String that, when a TagNode attempted to build this String into a TagNode instance, caused an exception to throw.

Class Torello.HTML.NodeExpectedException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.NodeIndex extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

CURRENT_NODES

java.util.Vector<HTMLNode> CURRENT_NODES

index

int index

An index to a node from a web-page. This index must point to a the exact same node inside of a vectorized-html page as the node stored in member-field HTMLNode 'n'.

n

NODE extends HTMLNode n

A HTMLNode from a web-page. This node is supposed to be the same node stored at the index specified by member-field int 'index' of some vectorized-html web-page in memory or on disk.

Class Torello.HTML.NodeNotFoundException extends NodeExpectedException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.OpeningTagNodeExpectedException extends TagNodeExpectedException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.PageStats extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

hasAVaccept

short hasAVaccept

The number of HTML TagNode elements that have a 'accept' attribute, when queried using TagNode.AV("accept")

hasAValt

short hasAValt

The number of HTML TagNode elements that have an 'alt' attribute, when queried using TagNode.AV("alt")

hasAVclass

short hasAVclass

The number of HTML TagNode elements that have a 'class' attribute, when queried using TagNode.AV("class")

hasAVcols

short hasAVcols

The number of HTML TagNode elements that have a 'cols' attribute, when queried using TagNode.AV("cols")

hasAVcolspan

short hasAVcolspan

The number of HTML TagNode elements that have a 'colspan' attribute, when queried using TagNode.AV("colspan")

hasAVheight

short hasAVheight

The number of HTML TagNode elements that have a 'height' attribute, when queried using TagNode.AV("height")

hasAVhref

short hasAVhref

The number of HTML TagNode elements that have an 'href' attribute, when queried using TagNode.AV("href")

hasAVhreflang

short hasAVhreflang

The number of HTML TagNode elements that have a 'hreflang' attribute, when queried using TagNode.AV("hreflang")

hasAVid

short hasAVid

The number of HTML TagNode elements that have an 'id' attribute, when queried using TagNode.AV("id")

hasAVmax

short hasAVmax

The number of HTML TagNode elements that have a 'max' attribute, when queried using TagNode.AV("max")

hasAVmaxlength

short hasAVmaxlength

The number of HTML TagNode elements that have a 'maxlength' attribute, when queried using TagNode.AV("maxlength")

hasAVmin

short hasAVmin

The number of HTML TagNode elements that have a 'min' attribute, when queried using TagNode.AV("min")

hasAVminlength

short hasAVminlength

The number of HTML TagNode elements that have a 'minlength' attribute, when queried using TagNode.AV("minlength")

hasAVname

short hasAVname

The number of HTML TagNode elements that have a 'name' attribute, when queried using TagNode.AV("name")

hasAVrows

short hasAVrows

The number of HTML TagNode elements that have a 'rows' attribute, when queried using TagNode.AV("rows")

hasAVrowspan

short hasAVrowspan

The number of HTML TagNode elements that have a 'rowspan' attribute, when queried using TagNode.AV("rowspan")

hasAVsize

short hasAVsize

The number of HTML TagNode elements that have a 'size' attribute, when queried using TagNode.AV("size")

hasAVsizes

short hasAVsizes

The number of HTML TagNode elements that have a 'sizes' attribute, when queried using TagNode.AV("sizes")

hasAVsrc

short hasAVsrc

The number of HTML TagNode elements that have a 'src' attribute, when queried using TagNode.AV("src")

hasAVsrcdoc

short hasAVsrcdoc

The number of HTML TagNode elements that have a 'srcdoc' attribute, when queried using TagNode.AV("srcdoc")

hasAVsrclang

short hasAVsrclang

The number of HTML TagNode elements that have a 'srclang' attribute, when queried using TagNode.AV("srclang")

hasAVsrcset

short hasAVsrcset

The number of HTML TagNode elements that have a 'srcset' attribute, when queried using TagNode.AV("srcset")

hasAVstyle

short hasAVstyle

The number of HTML TagNode elements that have a 'style' attribute, when queried using TagNode.AV("style")

hasAVtarget

short hasAVtarget

The number of HTML TagNode elements that have a 'target' attribute, when queried using TagNode.AV("target")

hasAVtitle

short hasAVtitle

The number of HTML TagNode elements that have a 'title' attribute, when queried using TagNode.AV("title")

hasAVtype

short hasAVtype

The number of HTML TagNode elements that have a 'type' attribute, when queried using TagNode.AV("type")

hasAVvalue

short hasAVvalue

The number of HTML TagNode elements that have a 'value' attribute, when queried using TagNode.AV("value")

hasAVwidth

short hasAVwidth

The number of HTML TagNode elements that have a 'width' attribute, when queried using TagNode.AV("width")

hasAVwrap

short hasAVwrap

The number of HTML TagNode elements that have a 'wrap' attribute, when queried using TagNode.AV("wrap")

hash

int hash

The string hash-code of the vectorized-HTML webpage, as if it were being represented as one single java.lang.String.

See Also:

Util.hashCode(Vector), Util.hashCode(Vector, int, int)

numBR

short numBR

The total number of HTML <BR> 'TagNode' elements found on the page.

NOTE: This is considered an HTML-5 'Singleton' element, and thusly should only have an "Opening-Tag Version" of the Element. If there are (accidentally) closing-versions of this tag, they will not be counted by class PageStats

numClosedAnchors

short numClosedAnchors

The total number of </A>, TC.ClosingTags, TagNode elements found on the page.

numClosedDivs

short numClosedDivs

The total number of </DIV>, TC.ClosingTags, TagNode elements found on the page.

numClosedForms

short numClosedForms

The total number of </FORM>, TC.ClosingTags, TagNode elements found on the page.

numClosedFrames

short numClosedFrames

The total number of </FRAME>, TC.ClosingTags, TagNode elements found on the page.

numClosedIFrames

short numClosedIFrames

The total number of </IFRAME>, TC.ClosingTags, TagNode elements found on the page.

numClosedParagraphs

short numClosedParagraphs

The total number of </P>, TC.ClosingTags, TagNode elements found on the page.

numClosedScripts

short numClosedScripts

The total number of </SCRIPT>, TC.ClosingTags, TagNode elements found on the page.

numClosedSpans

short numClosedSpans

The total number of </SPAN>, TC.ClosingTags, TagNode elements found on the page.

numClosedStyles

short numClosedStyles

The total number of </STYLE>, TC.ClosingTags, TagNode elements found on the page.

numClosedTables

short numClosedTables

The total number of </TABLE>, TC.ClosingTags, TagNode elements found on the page.

numCommentNodes

int numCommentNodes

The number of HTMLNode's in the Vector<HTMLNode> that qualify as an "instanceof" CommentNode.

See Also:

Util.countCommentNodes(Vector), Util.countCommentNodes(Vector, int, int)

numEmbed

short numEmbed

The total number of HTML <EMBED ...> 'TagNode' elements found on this page.

NOTE: This is considered an HTML-5 'Singleton' element, and thusly should only have an "Opening-Tag Version" of the Element. If there are (accidentally) closing-versions of this tag, they will not be counted by class PageStats

numHR

short numHR

The total number of HTML <HR> 'TagNode' elements found on the page.

NOTE: This is considered an HTML-5 'Singleton' element, and thusly should only have an "Opening-Tag Version" of the Element. If there are (accidentally) closing-versions of this tag, they will not be counted by class PageStats

numImages

short numImages

The total number of HTML <IMG ...> 'TagNode' elements found on the page.

NOTE: This is considered an HTML-5 'Singleton' element, and thusly should only have an "Opening-Tag Version" of the Element. If there are (accidentally) closing-versions of this tag, they will not be counted by class PageStats

numInput

short numInput

The total number of HTML <INPUT ...> 'TagNode' elements found on the page.

NOTE: This is considered an HTML-5 'Singleton' element, and thusly should only have an "Opening-Tag Version" of the Element. If there are (accidentally) closing-versions of this tag, they will not be counted by class PageStats

numLink

short numLink

The total number of HTML <LINK ...> 'TagNode' elements found on the page.

NOTE: This is considered an HTML-5 'Singleton' element, and thusly should only have an "Opening-Tag Version" of the Element. If there are (accidentally) closing-versions of this tag, they will not be counted by class PageStats

numMeta

short numMeta

The total number of HTML <META ...> 'TagNode' elements found on the page.

NOTE: This is considered an HTML-5 'Singleton' element, and thusly should only have an "Opening-Tag Version" of the Element. If there are (accidentally) closing-versions of this tag, they will not be counted by class PageStats

numNewLines

int numNewLines

This is the total number of new-line '\n' characters found inside any TextNode present in the page-vector.

See Also:

Util.countNewLines(Vector), Util.countNewLines(Vector, int, int)

numNodes

int numNodes

This is identical to the value returned by: pageVector.size()

numOpenAnchors

short numOpenAnchors

The total number of <A> (Anchor), TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenDivs

short numOpenDivs

The total number of <DIV> (Divider), TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenForms

short numOpenForms

The total number of <FORM>, TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenFrames

short numOpenFrames

The total number of <FRAME>, TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenIFrames

short numOpenIFrames

The total number of <IFRAME>, TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenParagraphs

short numOpenParagraphs

The total number of <P> (Paragraph), TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenScripts

short numOpenScripts

The total number of <SCRIPT>, TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenSpans

short numOpenSpans

The total number of <SPAN>, TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenStyles

short numOpenStyles

The total number of <STYLE>, TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numOpenTables

short numOpenTables

The total number of <TABLE>, TC.OpeningTags, TagNode elements found on the page. Any element-internal attributes / inner-tags actually found inside the HTML element will just be ignored for the purposes of this count.

numTagNodes

int numTagNodes

The number of HTMLNode's in the Vector<HTMLNode> that qualify as an "instanceof" TagNode.

See Also:

Util.countTagNodes(Vector), Util.countTagNodes(Vector, int, int)

numTextNodes

int numTextNodes

The number of HTMLNode's in the Vector<HTMLNode> that qualify as an "instanceof" TextNode.

See Also:

Util.countTextNodes(Vector), Util.countTextNodes(Vector, int, int)

strLength

int strLength

If a Vectorized HTML page were converted to a String, this would be the length of that string.

See Also:

Util.strLength(Vector), Util.strLength(Vector, int, int)

Class Torello.HTML.QuotesException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.ReplaceableException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.ReplaceableOutOfBoundsException extends ReplaceableException implements Serializable

serialVersionUID:

1L

Serialized Fields

r

Replaceable r

A reference to the Replaceable which caused this exception to throw

Class Torello.HTML.ReplaceablesOverlappingException extends ReplaceableException implements Serializable

serialVersionUID:

1L

Serialized Fields

r1

Replaceable r1

A reference to the first Replaceable which caused this exception to throw

r2

Replaceable r2

A reference to the second Replaceable which caused this exception to throw

Class Torello.HTML.ReplaceablesUnsortedException extends ReplaceableException implements Serializable

serialVersionUID:

1L

Serialized Fields

r1

Replaceable r1

A reference to the first Replaceable which caused this exception to throw

r2

Replaceable r2

A reference to the second Replaceable which caused this exception to throw

Class Torello.HTML.ScrapeException extends java.lang.IllegalStateException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.SingletonException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.SRCException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.SubSection extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

html

java.util.Vector<HTMLNode> html

This public field identifies the actual nodes - the vectorized-html sub-list - that are included in this sub-section of an html web-page.

See Also:

HTMLNode

location

DotPair location

This public field identifies the sub-section location of a particular sub-section from a vectorized-html webpage. The location of the sub-page is specified by the class DotPair public-fields: public final int 'start' and public final int 'end'

See Also:

DotPair

Class Torello.HTML.TagNode extends HTMLNode implements Serializable

serialVersionUID:

1L

Serialized Fields

isClosing

boolean isClosing

tok

java.lang.String tok

Class Torello.HTML.TagNodeExpectedException extends NodeExpectedException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.TagNodeIndex extends NodeIndex<TagNode> implements Serializable

serialVersionUID:

1L

Class Torello.HTML.TextNode extends HTMLNode implements Serializable

serialVersionUID:

1L

Class Torello.HTML.TextNodeExpectedException extends NodeExpectedException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.TextNodeIndex extends NodeIndex<TextNode> implements Serializable

serialVersionUID:

1L

Package Torello.HTML.NodeSearch

Class Torello.HTML.NodeSearch.CSSStrException extends TCCompareStrException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.NodeSearch.CursorException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Serialized Fields

maxCursor

int maxCursor

This will contain the value for maxCursor defined in an HTML Node Iterator's settings for the Cursor Bounds.

minCursor

int minCursor

This will contain the value for minCursor defined in an HTML Node Iterator's settings for the Cursor Bounds.

pos

int pos

This will contain the value for passed to an HNLI Iterator 'setter' method which was not within the bounds of the supplied Cursor Boundary Window.

Class Torello.HTML.NodeSearch.HTMLNotFoundException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.NodeSearch.InclusiveException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.NodeSearch.IteratorOutOfBoundsException extends java.lang.IndexOutOfBoundsException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.NodeSearch.SecondModificationException extends java.lang.IllegalStateException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.NodeSearch.TCCompareStrException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Serialized Fields

compareStrVec

java.util.Vector<java.lang.String> compareStrVec

This should contain the list of compare-String's passed for a parameter list to a TextComparitor.

i

int i

This field is intended to store the index into the 'compareStrVec' of the compare-String that caused the exception throw in the first place.

Package Torello.HTML.Tools.Images

Class Torello.HTML.Tools.Images.ImageInfo extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

actualExtension

IF actualExtension

If the image has been properly converted, and is ready to be written to disk, this parameter will contain the IF / image-format that was used to successfully save the image.

Note that often (but not always), this extension / IF instance will be identical to the parameter 'guessedImageFormat'. There will be cases, as mentioned above, when 'guessImageFormat' is null. Furthermore, there may be (very rare) situations when an image-format for a particular URL was incorrect, and was saved properly using a different format & extension.

b64EncodedImage

java.lang.String b64EncodedImage

A web-page has the ability to inline (smaller) images directly into an HTML <IMG SRC=...> tag by encoding the picture into a Base-64 String. The String is saved inside the SRC-Attribute of the <IMG> tag, and contains two separate sub-strings.

This is the second sub-string, and it is the text after translating the picture into Base-64 Encoded Text.

If the picture represented by this instance of ImageInfo was downloaded from a URL, then this field will be null, and the ImageInfo.url field will contain the Image URL.

See Also:

ImageInfo.isB64EncodedImage, ImageInfo.imageFormatStr

bufferedImage

java.awt.image.BufferedImage bufferedImage

The image, as an instance of java.awt.image.BufferedImage

fileName

java.lang.String fileName

guessedExtension

IF guessedExtension

This shall help identify whether the image-in-question is a GIF, JPG, PNG, etc.... The field 'guessedImageFormat' shall simply contain the image-type based on the extension found in the URL's file-name.

There are web-pages & web-sites that do not provide a file-name extension for the images they use on their page(s). In such cases, the downloader will eventually attempt to 'guess' the format of an image that has been downloaded. In these cases, this parameter will be passed null, and the parameter actualImageFormat will contain the format that was actually used to successfully save the data to disk.

height

int height

The value returned by bufferedImage.getHeight() - the downloaded image's height.

imageFormatStr

java.lang.String imageFormatStr

A web-page has the ability to inline (smaller) images directly into an HTML <IMG SRC=...> tag by encoding the picture into a Base-64 String. The String is saved inside the SRC-Attribute of the <IMG> tag, and contains two separate sub-strings.

This is the first sub-string, and it just identifies / lists the format (.jpg, .gif, .png etc...) in which the picture was saved before translating it into Base-64 Encoded Text.

If the picture represented by this instance of ImageInfo was downloaded from a URL, then this field will be null, and the ImageInfo.url field will contain the Image URL.

See Also:

ImageInfo.isB64EncodedImage, ImageInfo.b64EncodedImage

imgByteArr

byte[] imgByteArr

The image, as prepared for saving to disk.

isB64EncodedImage

boolean isB64EncodedImage

If the image whose details are contained by this class-instance are from an image that was encoded using the String-literal Base-64 Encoding Algorithm, then this boolean flag will contain TRUE.

An HTML <IMG SRC=...> Tag is the only way to enter a Base-64 Image into the Image-Scraper class.

iteratorCounter

int iteratorCounter

Identifies the count in the Iterator's retrieval. Since this int is used as an array-index pointer, it is initialized to '0' (zero). Specifically, if this method were called upon completion of three iterations of Image-URL retrieval, this counter would contain the integer '2' (two).

successCounter

int successCounter

This identifies how many images have successfully downloaded, not the number of images for which a "download attempt" occurred. Since this int is used as an array-index pointer, it is initialized to '0' (zero). If on the third iteration of the source-Iterator, an IOException occurred between the Java-Virtual-Machine and the internet, the following invocation of this method would have successCounter as '2', but the iteratorCounter would be '3'.

url

java.net.URL url

The URL that was used to download the image. Note that anytime this instance of ImageInfo represents an image that was located on a web-page encoded using a Base-64 String, then this field will be null, and the B-64 Fields will contain the relevant image data (not this URL).

width

int width

The value returned by bufferedImage.getWidth() - the downloaded image's width.

Class Torello.HTML.Tools.Images.ImageScraperException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Class Torello.HTML.Tools.Images.NullImageException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.Tools.Images.Request extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

alwaysUseUserAgent

boolean alwaysUseUserAgent

b64Images

java.util.Vector<java.lang.String[]> b64Images

b64Pos

int b64Pos

counterPrinter

java.util.function.IntFunction<java.lang.String> counterPrinter

fileNamePrefix

java.lang.String fileNamePrefix

When this field is non-null, this String will be prepended to each image file-name that is saved or stored to the file-system.

Setting to null:
This field may be null, and when it is, it shall be ignored. Upon construction, this class initializes this field to null.

getImageFileSaveName

java.util.function.Function<ImageInfo,java.lang.String> getImageFileSaveName

When this field is non-null, each time an image is written to the file-system, this function will be queried for a file-name before writing the the image-file.

Setting to null:
This field may be null, and when it is, it shall be ignored. Upon construction, this class initializes this field to null.

imageReceiver

java.util.function.Consumer<ImageInfo> imageReceiver

A functional-interface that allows a user to save an image-file to a location of his or her choosing. Implement this class if saving image files to a target-directory on the file-system is not acceptable, and the programmer wishes to do something else with the downloaded images.

Setting to null:
This field may be null, and when it is, it shall be ignored. Upon construction, this class initializes this field to null.

keeperPredicate

java.util.function.Predicate<ImageInfo> keeperPredicate

Allows for a user-provided decision-predicate about whether to retain & save, or discard, an image after downloading. All information available in data-flow class ImageInfo is provided to this predicate, and ought to be enough to decide whether or not to save or reject any of the downloaded image.

maxDownloadWaitTime

long maxDownloadWaitTime

If you do not want the downloader to hang on an image, which is sometimes an issue depending upon the site from which you are making a request, set this parameter, and the downloader will not wait past that amount of time to download an image. The default value for this parameter is 10 seconds. If you do not wish to set the max-wait-time "the download time-out" counter, then leave the parameter "waitTimeUnits" set to null, and this parameter will be ignored.

originalPageURL

java.net.URL originalPageURL

URL from whence this page has been downloaded

retryWithUserAgent

boolean retryWithUserAgent

size

int size

The number of Image-URL's identified inside the 'source' Iterable.

skipBase64EncodedImages

boolean skipBase64EncodedImages

This scraper has the ability to decode and save Base-64 Images, and they may be downloaded or skipped - based on this boolean. If an Iterable<TagNode> is passed to the constructor, and one of those TagNode's contain an Image Element (<IMG SRC="data:image/jpeg;base64,...data">) this class has the ability to interpret and save the image to a regular image file. By default, Base-64 images are skipped, but they can also be downloaded as well.

skipOnB64DecodeException

boolean skipOnB64DecodeException

Requests that the downloader-logic catch any & all exceptions that are thrown when decoding Base-64 Encoded Images. The failed conversion is simply reflected in the Results output arrays, and the download-process moves onto the next Iterable-Element.

Exception's Skipped:
This particular configuration-boolean allows a user to focus on exceptions that are thrown when Java's Base-64 Image-Decoder throws an exception.

skipOnDownloadException

boolean skipOnDownloadException

Requests that the downloader-logic catch any & all exceptions that are thrown when downloading images from an Internet-URL. The failed download is simply reflected in the Results output arrays, and the download-process moves onto the next Iterable-Element.

Exception's Skipped:
This particular configuration-boolean allows a user to focus on exceptions that are thrown while Java's ImageIO class is downloading and image, and suddenly fails.

skipOnImageWritingFail

boolean skipOnImageWritingFail

If an attempt is made to write an Image to the File-System, and an exception is thrown, this boolean requests that rather than throwing the exception, the downloader make a note in the log that a failure occured, and move on to the next image.

Exception's Skipped:
This particular configuration-boolean allows a user to focus on exceptions that are thrown when writing an already downloaded and converted image to the file-system.

skipOnNullImageException

boolean skipOnNullImageException

There are occasions when Java's ImageIO class returns a null image, rather than throwing an exception at all. In these cases, the ImageScraper class throws its own exception - unless this boolean has expressly requested to skip-and-move-on when the ImageIO returns null from downloading a URL.

Exception's Skipped:
This particular configuration-boolean allows a user to focus on exceptions that are thrown by the ImageScraper when a downloaded image is null.

skipOnTimeOutException

boolean skipOnTimeOutException

Requests that the downloader-logic catch any & all exceptions that are thrown while waiting for an image to finish downloading from an Internet-URL. The failed download is simply reflected in the Results output arrays, and the download-process moves onto the next Iterable-Element.

Exception's Skipped:
This particular configuration-boolean allows a user to focus on exceptions that are thrown when the Monitor-Thread has timed-out.

skipOnUserLambdaException

boolean skipOnUserLambdaException

This can be helpful if there are any "doubts" about the quality of the Functional-Interfaces that have been provided to this Request-instance.

Exception's Skipped:
This particular configuration-boolean allows a user to focus on exceptions that are thrown by any of the Lambda-Target / Functional-Interfaces that are provided by the user via this Request-instance.

skipURL

java.util.function.Predicate<java.net.URL> skipURL

If this field is non-null, then before any URL is connected for a download, the downloaded mechanism will ask this URL-Predicate for permission first. If this Predicate returns FALSE for a given URL, then that image will not be downloaded, but rather skipped, instead.

Setting to null:
This field may be null, and when it is, it shall be ignored. Upon construction, this class initializes this field to null.

source

java.lang.Iterable<java.net.URL> source

tagNodeSRCExceptions

java.util.Vector<java.lang.Exception> tagNodeSRCExceptions

targetDirectory

java.lang.String targetDirectory

When this configuration-field is non-null, this String parameter is used to identify the file-system directory to where downloaded image-files are to be saved.

Setting to null:
This field may be null, and when it is, it shall be ignored. Upon construction, this class initializes this field to null.

targetDirectoryRetriever

java.util.function.Function<ImageInfo,java.io.File> targetDirectoryRetriever

Allows a user to specify where to save an Image-File after being downloaded.

Setting to null:
This field may be null, and when it is, it shall be ignored. Upon construction, this class initializes this field to null.

tnExPos

int tnExPos

urlPreProcessor

java.util.function.Function<java.net.URL,java.net.URL> urlPreProcessor

When non-null, this allows a user to modify any image-URL immediately-prior to the ImageScraper beginning the download process for that image. This is likely of limited use, but there are certainly situations where (for example) escaped-characters need to be un-escaped prior to starting the download system.

In such cases, just write a lambda-target that accepts a URL, and processes it (in some way, of your chossing), and the downloader will use that updated URL-instance for making the HTTP-Connection to download the picture.

Setting to null:
This field may be null, and when it is, it shall be ignored. Upon construction, this class initializes this field to null.

useDefaultCounterForImageFileNames

boolean useDefaultCounterForImageFileNames

When true, images will be saved according to a counter; when this is FALSE, the software will attempt to save these images using their original filenames - picked from the URL. Saving using a counter is the default behaviour for this class.

userAgent

java.lang.String userAgent

This

verbosity

Verbosity verbosity

Allows a user of this utility to specify how the Level of Verbosity (or silence) is applied to the output mechanism while the tool is running.

Note that the Java enum Verbosity provides four distint levels, and that the class ImageScraper does indeed implement all four variants of textual output.

NullPointerException:
This field may not be null, or a NullPointerException: will throw!

waitTimeUnits

java.util.concurrent.TimeUnit waitTimeUnits

This is the "unit of measurement" for the field long maxDownloadWaitTime.

NOTE: This parameter may be null, and if it is both this parameter and the parameter long maxDownloadWaitTime will be ignored, and the default maximum-wait-time (download time-out settings) will be used instead.

READ: java.util.concurrent.*; package, and about the class java.util.concurrent.TimeUnit for more information.

Class Torello.HTML.Tools.Images.Results extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

b64EncodedImg

boolean[] b64EncodedImg

When constructing an ImageScraper's Request object, one of the options for building the instance is to pass a list of HTML TagNode instances containing HTML '<IMG SRC=...>' tags.

HTML TagNode elements will sometimes / occasionally have a variant of an image source known as the Base-64 Encoded Image. These are images where the actual pictures fully stored & encoded inside the SRC-Attribute of the HTML TagNode's SRC-Attribute.

Base-64 Images are just pictures that have been converted into actual character data, in the form of a simple String, and saved into the <IMG> tag's SRC-URL - instead of an actual HTTP URL being saved there. Note that this practice is generally used for much smaller pictures, thumbnails or logo signs (images that wouldn't use up a lot of data).

A full explanation of HTML's Base-64 Image-Encoding is beyone the scope of this Java-Doc Comment.

If any image was "converted" from a B-64 Image-Encoding (rather than downloaded from a URL), then the boolean for the image's index will be TRUE rather than FALSE. The default value for all elements of this array is FALSE.

exceptions

java.lang.Exception[] exceptions

If any stage of the image download, conversion or disk-write fails, then this array will store a record the exception that was thrown.

If the download succeeded, then the 'exceptions'-array element at that index would contain 'null.' Any exceptions-array index that contains a non-null Exception will be an index for which the Results.skipped-array contains a TRUE-value stored at the same location.

fileNames

java.lang.String[] fileNames

The names of the files that were retrieved and/or stored will be in this array. If this image were skipped or an exception occurred, the array position for that URL would contain 'null'.

It is important to note that if an element of this array contains a valid, non-null, file-name - it does not guarantee that the image was properly saved. The value stored in the corresponding (parallel) Results.skipped-array index is the only way to ascertain whether an image was ultimately written to disk (or transmitted to a User-Provided Request.imageReceiver).

heights

int[] heights

This shall contain a list of integers, each of which shall have the image-heights of the downloaded images.

imageFormats

IF[] imageFormats

The image type of the files that were retrieved will be stored in this array.

pos

int pos

saveDirectories

java.lang.String[] saveDirectories

The location of the file-name saved directory, if an image did not successfully save to the file system, or if an imageReceiver were used, then the array-location would contain 'null'.

sizes

long[] sizes

This will contain a list of long-integers, each of which will have the file-size of the downloaded image.

skipped

boolean[] skipped

An images Results-data in this particular paralell-array will be TRUE under any of the following circumstances:

• If the user provided a Request.skipURL-Predicate, and that predicate rejected the image (telling the downloader not to download the picture).
  
  
• If the user provided a Request.keeperPredicate, and that predicate, after image-downloade complettion, rejected the image (telling the downloader not save the picture to disk the picture).
  
  
• If there were any exceptions thrown while downloading the image that forced the downloader-logic to abandon the image (and either throw the exception, or skip-and-move-on to the next image).
  
  
• If the original Iterable that was provided to the Request-instance had entries that had caused exceptions to be thrown while building the Request-instance.

Under any / all other circumstances, if an image was successfully downloaded and written to disk, then the corresponding element in this array will contain FALSE!

successCounter

int successCounter

urls

java.net.URL[] urls

This will contain a complete list of the URL's that were retrieved (or generated- if partially-resolved 'relative' URL's were provided) from the Request-instances static-builder. Every image downloaded (or attempted for download) will have its URL saved here, in this array.

Null's in the urls Array
An array-element of the urls-array will contain null under the following two circumstances:

• No image-URL was provided, becasue the picture was a Base-64 Encoded Image, and instead was a String that had been retrieved from a TagNode's SRC-Attribute.
  
  
• The user provided a String to the Request Class builder, but that String caused a MalformedURLException, and no URL-instance was ever built. (Note that in this scenario, the Results.exceptions array would be storing the URL-Exception that was thrown).
  
  

widths

int[] widths

This will contain a list of integers, each of which shall have the image-widths of the downloaded images.

Package Torello.HTML.Tools.NewsSite

Class Torello.HTML.Tools.NewsSite.Article extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

articleBody

java.util.Vector<HTMLNode> articleBody

This is the pared down article-body. It is what is retrieved from class ArticleGet

imagePosArr

int[] imagePosArr

This list contains the "Image Positions" inside the vectorized-article for each image that was found inside the article. The easiest way to think about this field is that the following instructions were called on the article-body after downloading that article:

int[] imagePosArr = TagNodeFind.all(page, TC.OpeningTags, "img");

imageURLs

java.util.Vector<java.net.URL> imageURLs

The image-URL's that were found in the news-article. The easiest way to think about this field is that the following instructions were called on the article-body after downloading the article:

Vector<TagNode> imageNodes = TagNodeGet.all(article, TC.OpeningTags, "img"); Vector<URL> imageURLs = Links.resolveSRCs(imageNodes, articleURL); // The results of the above call are stored in this field / Vector<URL>.

originalPage

java.util.Vector<HTMLNode> originalPage

This is the original, and complete, HTML vectorized-page download. It contains the original, un-modified, article download.

originalPageStats

PageStats originalPageStats

This contains an instance of class PageStats that has been generated out of an original Newspaper Article Page.

this.originalPageStats = new PageStats(originalPage);

processedArticleStats

PageStats processedArticleStats

This contains an instance of class PageStats that has been generated from the post-processed Newspaper Article.

this.processedArticleStats = new PageStats(articleBody);

titleElement

java.lang.String titleElement

This is the title that was scraped from the main page. The title is the content of the <TITLE>...</TITLE> element on the article HTML page.

url

java.net.URL url

This is the article's URL from the news website.

wasErrorDownload

boolean wasErrorDownload

This should inform the user that an error occurred when downloading an article. If this field, after instantiation is TRUE, all other fields in this class should be thought of as "irrelevant."

Class Torello.HTML.Tools.NewsSite.ArticleGetException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Serialized Fields

page

java.util.Vector<HTMLNode> page

If the code that has generated this exception has decided to pass the HTML page-Vector as a parameter to the constructor it has used, when this exception is thrown, that page will be retained in this public, final parameter. Not all four of the provided constructor's for this exception require the page and url be preserved. If the throwing code has declined to provide this reference to the constructor, then the value of this 'page' field will be null.

url

java.net.URL url

If the code that has generated this exception has decided to pass the HTML page-URL as a parameter to the constructor it has used, when this exception is thrown, that page will be retained in this public, final parameter. Not all four of the provided constructor's for this exception require the 'page' and 'URL' be preserved. If the throwing code has declined to provide this reference to the constructor, then the value of this 'URL' field will be null.

Class Torello.HTML.Tools.NewsSite.NewsSite extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

articleGetter

ArticleGet articleGetter

An instance of ArticleGet used to retrieve news-articles from this site.

See Also:

ScrapeArticles

bannerAndAddFinder

StrFilter bannerAndAddFinder

An instance of StrFilter for finding banner's or ad's

See Also:

ScrapeArticles

country

Country country

Country of origin for the news-site in question

description

java.lang.String description

A simple text description of the news web-site

filter

URLFilter filter

An instance of URLFilter for filtering out certain URL's from the list of scraped article-URL's.

See Also:

ScrapeURLs

languageCode

LC languageCode

A Language Code instance for the web-site, if needed.

linksGetter

LinksGet linksGetter

An instance of LinksGet for retrieving Article-URL links from a section page

See Also:

ScrapeURLs

sectionURLs

java.util.Vector<java.net.URL> sectionURLs

Should contain the complete list of news-section URL's

See Also:

ScrapeURLs.get(Vector, URLFilter, LinksGet, Appendable)

siteName

java.lang.String siteName

A Simple Name for the news-site

siteURL

java.net.URL siteURL

URL of the main-page for the news web-site

Class Torello.HTML.Tools.NewsSite.NewsSiteException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.Tools.NewsSite.PauseException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.HTML.Tools.NewsSite.ReceiveException extends java.io.IOException implements Serializable

serialVersionUID:

1L

Serialized Fields

articleNum

int articleNum

This is the Vector-index into the News Web-Site "Newspaper Article" Vector for the Article that was being processed by ScrapedArticleReceiver when the ReceiveException was thrown.

sectionURLNum

int sectionURLNum

This is the News Web-Site "Section" that was being processed when this ReceiveException was thrown.

Class Torello.HTML.Tools.NewsSite.SectionURLException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Package Torello.HTML.Tools.SearchEngines

Class Torello.HTML.Tools.SearchEngines.BaiDuQuery.SearchResult extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

subResults

BaiDuQuery.SearchResult[] subResults

Usually, this array will be null. Note, null will be used in place of a zero length array. There are some sites for which a search-result would have multiple, or even numerous matches for a given search-String. When a search using 百度 provides more than one result, the list of 'Additional Matches' are scraped and put into this array.

title

java.lang.String title

This is the "Anchor Text" that 百度 provided for this link. To be specific, it is the text between the <A HREF=url> and the </A>.

url

java.lang.String url

This is the link of 'this' search result.

Class Torello.HTML.Tools.SearchEngines.GoogleQuery.SearchResult extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

subResults

GoogleQuery.SearchResult[] subResults

Usually, this array will be null. Note, null will be used in place of a zero length array. There are some sites for which a search-result would have multiple, or even numerous matches for a given search-String. When a search using Google provides more than one result, the list of 'Additional Matches' are scraped and put into this array.

title

java.lang.String title

This is the "Anchor Text" that Google provided for this link. To be specific, it is the text between the <A HREF=url> and the </A>.

url

java.lang.String url

This is the link of 'this' search result.

Package Torello.Java

Class Torello.Java.ArrayExpectedError extends ExceptionCheckError implements Serializable

serialVersionUID:

1L

Class Torello.Java.CacheError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Class Torello.Java.CallableBodyException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.Java.DirExpectedException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

fn

FileNode fn

This public final field contains the FileNode that caused an exception to throw.

Class Torello.Java.EMailLists extends java.util.TreeMap<java.lang.String,java.lang.String[]> implements Serializable

serialVersionUID:

1L

Serialized Fields

DATA_FILE_NAME

java.lang.String DATA_FILE_NAME

This stores the name of the data-file that contains the Rolodex information. It is a compressed (ZIP-format Compression), java java.io.serializable object file containing just a single data object of type: "java.util.TreeMap<String, String[]>"

Class Torello.Java.ExceptionCheckError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Class Torello.Java.FileExpectedException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

fn

FileNode fn

This public final field contains the FileNode that caused an exception to throw.

Class Torello.Java.FileNode extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

children

java.util.Vector<FileNode> children

This variable remains null for all instances of this class which represent 'files' on the underlying operating-system, rather than 'directories.' On the other hand, if 'this' instance of FileNode represents an MS-DOS, Unix, or Apple OS directory, then field Vector<FileNode> children will be instantiated and hold all files and sub-directories which are found.

fileSize

long fileSize

When a tree is loaded into memory, the size of each file is saved in this variable. It can be retrieved (and even changed).

isDirectory

boolean isDirectory

If 'this' class-instance represents a directory in the BASH/UNIX or MS-DOS file system, this variable will be TRUE.

lastModified

long lastModified

When a tree is loaded into memory, the file-date of the file is saved in this variable. It can be retrieved. If the SecurityManager.checkRead(fileName) denies read access to the file, this field will equal zero.

NOTE: This field is a Java simple-type 'long' which represents the time the file was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)

name

java.lang.String name

The name of the file or directory is saved/stored here

parent

FileNode parent

The parent/container 'FileNode' directory is saved here - like a pointer "tree".

Class Torello.Java.FileSizeException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

fileSize

long fileSize

This final field will contain the size of the file which generated this errror.

Class Torello.Java.LV extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

end

int end

This integer represents the ending point of a for-loop. It is guaranteed to be consistent with the Vector that was used with the constructor of this class.

start

int start

This integer represents the starting point of a for-loop. It is guaranteed to be consistent with the Vector that was used with the constructor of this class.

Class Torello.Java.NException extends java.lang.IndexOutOfBoundsException implements Serializable

serialVersionUID:

1L

Class Torello.Java.NoMatchException extends RegExException implements Serializable

serialVersionUID:

1L

Class Torello.Java.OSResponse extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

commandStr

java.lang.String commandStr

Maintains a copy of the command (as a String) that produced this instance

errorOutput

java.lang.String errorOutput

This public, final, String field will contain a transcript of the text-character data that the Operating-System process sent to Standard-Error.

response

int response

This public, final, int field will hold the "response code" reported by the operating-system. The response-code is a number returned by the invocation of the command to the OS. A value of -1 usually signifies that the process terminated with errors. If this field contains a value of Shell.INTERRUPTED, it will mean that the process was interrupted.

standardOutput

java.lang.String standardOutput

This public, final, String field will contain a transcript of the text-character data that the Operating-System process sent to Standard-Output.

Class Torello.Java.ParallelArrayException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.Java.RegExException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.Java.SameSourceAndTargetException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.Java.StrCmprException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Serialized Fields

compareStrVec

java.util.Vector<java.lang.String> compareStrVec

This should contain the list of compare-String's passed for a parameter list to class StrCmpr.

i

int i

This field is intended to store the index into the compareStrVec of the compare-String that caused the exception throw in the first place.

Class Torello.Java.StringFormatException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.Java.ToDoException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.Java.UnreachableError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Class Torello.Java.VarTypeParamException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.Java.WritableDirectoryException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Package Torello.Java.Additional

Class Torello.Java.Additional.AppendableError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.AsynchronousException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonArithmeticArrException extends JsonBindingArrException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonArithmeticObjException extends JsonBindingObjException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonBindingArrException extends JsonBindingException implements Serializable

serialVersionUID:

1L

Serialized Fields

index

int index

This is the array index into the source JsonArray which contained the element (or lack-there-of) that has caused this exception.

Class Torello.Java.Additional.JsonBindingException extends JsonException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorSourceJsonStruct

JsonStructure errorSourceJsonStruct

This contains the actual JsonStructure (which should either be an instance of JsonObject or JsonArray) which contained the array-element or object-property that has caused this exception throw.

expectedJsonType

JsonValue.ValueType expectedJsonType

This contains the expected type which ought to have been found at the user-specified JsonArray or JsonObject location. Since both of these kinds of JsonStructure are only allowed to have Json-Type's; therefore this field's declared type is JsonValue.ValueType.

ASIDE: The enum JsonValue.ValueType has two enum-constants which represent the Json-Type 'Boolean'. As a result, there are two possible values to which this field could be assigned to symbolize a Json Boolean Type (JsonValue.ValueType.FALSE and JsonValue.ValueType.TRUE). However, in Java HTML, a Json-Boolean Type will always be represented using the TRUE enum-constant.

methodReturnJavaType

java.lang.Class<?> methodReturnJavaType

This specifies return type (as an instance of java.lang.Class<T> that is used by the method which has thrown this exception. This is the Java-Type to which the Json-Type was going to be assigned.

valueRetrieved

JsonValue valueRetrieved

This is the value retrieved from the JsonArray or JsonObject. If the value was not present or unavailable, then this parameter will, indeed, evaulated to Java-Null. If Json-Null was retrieved, then this parameter will contain JsonValue.NULL.

Class Torello.Java.Additional.JsonBindingObjException extends JsonBindingException implements Serializable

serialVersionUID:

1L

Serialized Fields

propertyName

java.lang.String propertyName

The JsonObject property-name that has caused this exception to throw.

Class Torello.Java.Additional.JsonNullArrException extends JsonBindingArrException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonNullObjException extends JsonBindingObjException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonNullPrimitiveArrException extends JsonBindingArrException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonNullPrimitiveObjException extends JsonBindingObjException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonPropMissingException extends JsonBindingObjException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonStrParseArrException extends JsonBindingArrException implements Serializable

serialVersionUID:

1L

Serialized Fields

s

java.lang.String s

The String that couldn't be properly parsed, and has caused this exception throw.

Class Torello.Java.Additional.JsonStrParseObjException extends JsonBindingObjException implements Serializable

serialVersionUID:

1L

Serialized Fields

s

java.lang.String s

The String that has caused the exception.

Class Torello.Java.Additional.JsonTypeArrException extends JsonBindingArrException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.JsonTypeObjException extends JsonBindingObjException implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.LRUTreeMap extends java.util.TreeMap<K,V> implements Serializable

serialVersionUID:

1L

Serialized Fields

mapLRU

Torello.Java.Additional.LRUTreeMap.LRUTreeMaps mapLRU

Keeps a record of the 'Ordering of Use' for the elements in 'this' map. The values stored here are set by a counter that increases with each use.

MAX_NUM_ELEMENTS

int MAX_NUM_ELEMENTS

This is, literally, the maximum number of Key-Value pairs allowed into this instance of LRUTreeMap. When an insert or 'put' operation is made after the tree has reached this maximum size, it will remove the oldest element in the tree, first, before inserting the new addition(s)j.

Class Torello.Java.Additional.Promise extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

error

boolean error

errorCode

int errorCode

errorMessage

java.lang.String errorMessage

receiver

java.util.function.Function<RESPONSE,RESULT> receiver

This is the "Respone Processor". As of the writing of this class, the only use that the three classes: Script, Promise & Sender has been for implementing the Google Chrome Browser Remote Debug Protocol. (Although perhaps these classes will one day be used with a different asychronous protocol) In this current case (Browser RDP), this receiver is actually doing the "JSON Binding" to bind the JsonObject received from the Browser into a Java Class that the user can actually use.

response

boolean response

result

RESULT result

Class Torello.Java.Additional.Ret0 extends RetN implements Serializable

serialVersionUID:

1L

Class Torello.Java.Additional.Ret1 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a

A a

This holds a pointer the first and only response object.

Class Torello.Java.Additional.Ret2 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a

A a

This holds a pointer the first response object.

b

B b

This holds a pointer to the second response object.

Class Torello.Java.Additional.Ret3 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a

A a

This holds a pointer the first response object.

b

B b

This holds a pointer to the second response object.

c

C c

This holds a pointer to the third response object.

Class Torello.Java.Additional.Ret4 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a

A a

This holds a pointer the first response object.

b

B b

This holds a pointer to the second response object.

c

C c

This holds a pointer to the third response object.

d

D d

This holds a pointer to the fourth response object.

Class Torello.Java.Additional.Ret5 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a

A a

This holds a pointer the first response object.

b

B b

This holds a pointer to the second response object.

c

C c

This holds a pointer to the third response object.

d

D d

This holds a pointer to the fourth response object.

e

E e

This holds a pointer to the fifth response object.

Class Torello.Java.Additional.Ret6 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a1

A1 a1

This holds a pointer the first response object.

b2

B2 b2

This holds a pointer to the second response object.

c3

C3 c3

This holds a pointer to the third response object.

d4

D4 d4

This holds a pointer to the fourth response object.

e5

E5 e5

This holds a pointer to the fifth response object.

f6

F6 f6

This holds a pointer to the sixth response object.

Class Torello.Java.Additional.Ret7 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a1

A1 a1

This holds a pointer the first response object.

b2

B2 b2

This holds a pointer to the second response object.

c3

C3 c3

This holds a pointer to the third response object.

d4

D4 d4

This holds a pointer to the fourth response object.

e5

E5 e5

This holds a pointer to the fifth response object.

f6

F6 f6

This holds a pointer to the sixth response object.

g7

G7 g7

This holds a pointer to the seventh response object.

Class Torello.Java.Additional.Ret8 extends RetN implements Serializable

serialVersionUID:

1L

Serialized Fields

a1

A1 a1

This holds a pointer the first response object.

b2

B2 b2

This holds a pointer to the second response object.

c3

C3 c3

This holds a pointer to the third response object.

d4

D4 d4

This holds a pointer to the fourth response object.

e5

E5 e5

This holds a pointer to the fifth response object.

f6

F6 f6

This holds a pointer to the sixth response object.

g7

G7 g7

This holds a pointer to the seventh response object.

h8

H8 h8

This holds a pointer to the seventh response object.

Class Torello.Java.Additional.Script extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultSender

Sender<INPUT> defaultSender

When opening a connection to an asynchronous channel, for instance a Web-Socket to a Google Chrome Browser, the web-socket connecton to that browser receives messages from this sender.

If a user needs to have more than one browser opened at the same time, a second sender can be created, and messages may be sent to a different browser by using the Script.exec(Sender) method.

receiver

java.util.function.Function<RESPONSE,RESULT> receiver

The Promise that is produced by this class, after invoking an 'exec' method needs to be able to do any processing on the raw-output that is received from the Asynchronous Communication's Channel.

If the type of the 'RESPONSE' was JsonObject, then this function pointer would have to perform the Json-Binding to convert the JsonObject into a Java Object (ultimately having type 'RESULT').

request

INPUT request

This is the request that the 'sender' is going to send over the Asynchronous I/O Channel.

requestID

int requestID

ID number that was ascribed to this request. Each request must have an ID because this script is used in an asynchronous communications context. The only way to link a response to a request is by matching an ID number received as a response, to an ID that was sent with a particular request.

Package Torello.JavaDoc

Class Torello.JavaDoc.AnnotationElem extends Declaration implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultValue

java.lang.String defaultValue

The default value assigned to this element. This may be null if there is no assigned default value.

type

java.lang.String type

An Annotation-Element may only assume one of several types, as per the Java Sun / Oracle Documentation. The type must be one of the following, or a compile-time error occurs:

• a primitive type
• String
• Class or an invocation of Class
• An enum type
• An annotation type
• An (1 dimensional) array type whose component type is one of the preceding types

typeJOW

java.lang.String typeJOW

JOW: Just One Word

The Just One Word convention in the upgrader tool elminates package-name information from type-String's.

Class Torello.JavaDoc.Callable extends Declaration implements Serializable

serialVersionUID:

1L

Serialized Fields

autoFindID

java.lang.String autoFindID

exceptions

java.lang.String[] exceptions

The names of all Exception, Error and Throwable that may be thrown by this Constructor or Method.

NOTE: Only exceptions which are included in the actual Declaration.signature, inside the original '.java' source-file for this Callable will be listed in this array.

If this Callable instance represents a Method or Constructor that does have any declared throw-statements, then this field is assigned null.

See Also:

Callable.getExceptions(), Callable.getExceptions(Consumer), Callable.hasException(String)

parameterAnnotations

java.lang.String[][] parameterAnnotations

Any parameters that are annotated will have the exact text-String of the annotations that were used in the source-code for that parameter stored in this two-dimensional String[][] array.

Java Parser offers a variant of the standard toString() that is known as the LexicalPreservingPrinter. This printer can retrieve the actual character data that may be found in the source-code file for an element in a Java Parser 'AST' (Abstract Syntax Tree). The list of annotations on a parameter (if any) will each be saved as a java.lang.String.

NOTE: In almost all cases (particularly in the Java HTML Library), this two-dimensional array, itself, will simply be null - since parameter annotations are somewhat uncommon - although, perhaps, some users make use of them from time to time.

ALSO: This array must be considered as a parallel array to the other arrays, 'parameterNames' and 'parameterTypes'.

Item	Possibility of being null
parameterAnnotations	null if this Method or Constructor has zero arguments
parameterAnnotations[i]	Always null, unless the ith parameter of this Callable was annotated with something
parameterAnnotations[i][j]	Will never be null, (again, as long as parameterAnnotations[i] is not null. Note that there may be more than one annotation on a given parameter, which is the whole reason for having a second array-dimension.

See Also:

Callable.getParameterAnnotations(), Callable.getParameterAnnotations(int)

parameterNames

java.lang.String[] parameterNames

The names of all parameters to this Method or Constructor.

IMPORTANT: This array must be considered an array that is parallel to the other two arrays, Callable.parameterTypes and Callable.parameterTypesJOW

If this Callable instance represents a Method or Constructor that does not accept any parameters, then this field is assigned null.

See Also:

Callable.getParameterNames(), Callable.getParameterNames(Consumer), Callable.hasParameterNamed(String), Callable.getParameterName(int)

parameterTypes

java.lang.String[] parameterTypes

This contains the types of the parameters, stored as String's. The contents of these String's do include: package-name, containing classes (if inner-classes), and generic-parameter expressions (if generic-types). These names are as fully-qualified as the Java Parser Library allows.

NOTE: The protected String[] array Callable.parameterTypesJOW reduces these types (as String's) to a single-word. If a Method or a Constructor accepted a paremeter such as java.util.Iterable<Integer>, and this seemed 'difficult to work with' - the entry in parameterTypesJOW at the same array-location would contain, simply, Iterable.

IMPORTANT: This array must be considered an array that is parallel to the other two arrays, Callable.parameterNames and Callable.parameterTypesJOW.

If this Callable instance represents a Method or Constructor that does not accept any parameters, then this field is assigned null.

See Also:

Callable.parameterTypesJOW, Callable.getParameterTypes(), Callable.getParameterTypes(Consumer), Callable.hasParameterTyped(String), Callable.getParameterType(int)

parameterTypesJOW

java.lang.String[] parameterTypesJOW

IMPORTANT: This array must be considered an array that is parallel to the other two arrays, Callable.parameterNames and Callable.parameterTypes

If this Callable instance represents a Method or Constructor that does not accept any parameters, then this field is assigned null.

See Also:

Callable.parameterTypes, Callable.getParameterTypesJOW(), Callable.getParameterTypesJOW(Consumer), Callable.hasParameterTypedJOW(String), Callable.getParameterTypeJOW(int)

Class Torello.JavaDoc.Constructor extends Callable implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.Declaration extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

annotations

java.lang.String[] annotations

ALSO: If this Declaration instance has not had any annotations placed on it, then this field will be a non-null, zero-length String[]-Array.

See Also:

Declaration.getAnnotations(), Declaration.getAnnotations(Consumer), Declaration.hasAnnotations(), Declaration.numAnnotations()

body

java.lang.String body

The Body of this 'Entity' (Field, Method, Constructor, EnumConstant, AnnotationElem or NestedType) as a String - if one exists.

If this Entity / Member (Field, Method, Constructor etc...) did not have a body, then this field 'body' will be null.

The 'body' of a Method or Constructor is exactly the code that comprises it. If the method is abstract, then the method will not have a body, and in such cases this field will be null. If this member / entity is a Field then the body is the initializer of the Field. Again, if there were no initializer for the field, then 'body' would also be null.

entity

Entity entity

This just stores the type of Entity this is. For sub-classes instances of Declaration which are Method, this field will be equal to Entity.METHOD. For instances of the Field sub-class, this will equal Entity.FIELD, and so on and so forth.

Mostly, this makes code easier to read when used along-side if-statements or switch-statements than something akin to Declaration.getClass() (when retrieving the specific Declaration sub-class type).

NOTE: Both this class, and sub-class Callable are declared abstract, and only instances of Method, Field, Constructor, etc... can be instantiated.

id

int id

For the purposes of passing these around to different parts of the code, every one of of these are given a unique ID. This id is unique for a method, whether it was parsed from a detail or a summary section. This id is (probably) not useful outside of the HTML Processor Classes.

NOTE: If a subclass of Declaration is cloned, then this id field is also cloned / copied.

jdComment

java.lang.String jdComment

The Java Doc Comment of this 'Entity' (Field, Method, Constructor, EnumConstant, AnnotationElem or NestedType) as a String - if one exists. The Java Doc Comment is the one defined directly above the Declaration.

If this Entity / Member (Field, Method, Constructor etc...) did not have a Java Doc Comment placed on it, then this field 'jdComment' will be null.

location

Location location

Location instance that contains character-locations within the original Java Source-File

modifiers

java.lang.String[] modifiers

The 'modifiers' placed on this Declaration. This includes String's such as: public, static, final etc...

ALSO: If this Declaration instance has not had any annotations placed on it, then this field will be a non-null, zero-length String[]-Array.

See Also:

Declaration.getModifiers(), Declaration.getModifiers(Consumer), Declaration.hasModifier(String), Declaration.hasModifiers(), Declaration.numModifiers()

name

java.lang.String name

The Name of the java Field, Method, Constructor, EnumConstant or AnnotationElem. This will be a simple, standard 'Java Identifier'.

Note that the name of a Constructor (for-example) is always just the name of the class.

This field will never be null.

signature

java.lang.String signature

The complete, declared Signature (as a String) of the Method, Field, Constructor, EnumConstant or AnnotationElem.

This field would never be null.

Class Torello.JavaDoc.DetailsException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.EnumConstant extends Declaration implements Serializable

serialVersionUID:

1L

Serialized Fields

paramExpressions

java.lang.String[] paramExpressions

The parameters passed to the constructor that constructed the enumerated-constant instance.

Many enum's do not use constructors for their constants - using a constructor is an extra-feature that allows other, informational data to be ascribed to the constant. If no constructor was used, then there (obviously) couldn't have been any expressions passed to a constructor for the constant. In such cases, this field will be null.

Class Torello.JavaDoc.Field extends Declaration implements Serializable

serialVersionUID:

1L

Serialized Fields

definition

java.lang.String definition

The definition of this field, as a String.

type

java.lang.String type

The type / class of this field, as a String.

typeJOW

java.lang.String typeJOW

The type / class of this field, as a String.

Class Torello.JavaDoc.HiLiteError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.HiLiteException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.JavaDocError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.JavaDocHTMLFile extends ParsedFile implements Serializable

serialVersionUID:

1L

Serialized Fields

aeDetailsRemoved

boolean aeDetailsRemoved

Identifies if this Java Doc HTML Page has had it's Annotation-Element Details Removed

allAEDetails

java.util.Vector<ReflHTML<AnnotationElem>> allAEDetails

allConstructorDetails

java.util.Vector<ReflHTML<Constructor>> allConstructorDetails

allECDetails

java.util.Vector<ReflHTML<EnumConstant>> allECDetails

allFieldDetails

java.util.Vector<ReflHTML<Field>> allFieldDetails

allMethodDetails

java.util.Vector<ReflHTML<Method>> allMethodDetails

allNonNullSummaryTables

java.util.Vector<SummaryTableHTML> allNonNullSummaryTables

all non-null SummaryTableHTML instances

constructorDetailsRemoved

boolean constructorDetailsRemoved

Identifies if this Java Doc HTML Page has had it's Constructor Details Removed

constructorSummaryTable

SummaryTableHTML<Constructor> constructorSummaryTable

The HTML for a Constructor Summary Table

dotDots

java.lang.String dotDots

This provides the relative path-String from 'this' Java Doc generated HTML File to the root Java Doc directory.

ecDetailsRemoved

boolean ecDetailsRemoved

Identifies if this Java Doc HTML Page has had it's Enumeration Constant Details Removed

ecSummaryTable

SummaryTableHTML<EnumConstant> ecSummaryTable

The HTML for an Enum-Constant Summary Table

fieldDetailsRemoved

boolean fieldDetailsRemoved

Identifies if this Java Doc HTML Page has had it's Field Details Removed

fieldSummaryTable

SummaryTableHTML<Field> fieldSummaryTable

The HTML for a Field Summary Table

fileVec

java.util.Vector<HTMLNode> fileVec

headerFooter

HeaderFooterHTML headerFooter

The HTML that occurs directly above the Summary-Tables is the header. The HTML that is located below the Detail-Entries is the footer.

hiLitedSrcFileURL

java.lang.String hiLitedSrcFileURL

This is the File-URL to use if a need to link to the corresponding "/hilite-files/" file is necessary.

This is a relative-URL that is relative to the file from the location where this Java Doc HTML File is located. Specifically, this String begins with the text "/hilite-files/", followed by the type-name, and ending with the extension ".java.html"

methodDetailsRemoved

boolean methodDetailsRemoved

Identifies if this Java Doc HTML Page has had it's Method Details Removed

methodSummaryTable

SummaryTableHTML<Method> methodSummaryTable

The HTML for a Method Summary

ntSummaryTable

SummaryTableHTML<NestedType> ntSummaryTable

The HTML for a Nested-Class (Inner-Class) Summary Table

oaeSummaryTable

SummaryTableHTML<AnnotationElem> oaeSummaryTable

The HTML for an Optional Annotation Element Summary Table

raeSummaryTable

SummaryTableHTML<AnnotationElem> raeSummaryTable

The HTML for a Required Annotation Element Summary Table

srcAsHTMLFileURL

java.lang.String srcAsHTMLFileURL

This is the File-URL to use if a need to link to the corresponding "/src-html/" file is necessary.

This is a relative-URL that contains the requisite number of 'dot-dots' to reach the file from the location where this Java Doc HTML File is located.

updatedFileVec

java.util.Vector<HTMLNode> updatedFileVec

Class Torello.JavaDoc.JavaDocHTMLParseException extends ParseException implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.Location extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bodyEndCol

int bodyEndCol

bodyEndLine

int bodyEndLine

bodyEndPos

int bodyEndPos

bodyStartCol

int bodyStartCol

bodyStartLine

int bodyStartLine

bodyStartPos

int bodyStartPos

jdcEndCol

int jdcEndCol

jdcEndLine

int jdcEndLine

jdcEndPos

int jdcEndPos

jdcStartCol

int jdcStartCol

jdcStartLine

int jdcStartLine

jdcStartPos

int jdcStartPos

signatureEndCol

int signatureEndCol

signatureEndLine

int signatureEndLine

signatureEndPos

int signatureEndPos

signatureStartCol

int signatureStartCol

signatureStartLine

int signatureStartLine

signatureStartPos

int signatureStartPos

Class Torello.JavaDoc.Method extends Callable implements Serializable

serialVersionUID:

1L

Serialized Fields

returnType

java.lang.String returnType

The return type of the method, as a String. If this is a method with a 'void' return-type, this shall be "void".

NOTE: The parsed return-type will include the full-package name of the returned class (or interface), if the method returns a class or interface.

returnTypeJOW

java.lang.String returnTypeJOW

The return type of the method, as a String.

Class Torello.JavaDoc.NestedType extends Declaration implements Serializable

serialVersionUID:

1L

Serialized Fields

ciet

CIET ciet

Identifies whether this is a nested/inner Class, Interface, Enum, Annotation etc...

extendedTypesJOW

java.lang.String[] extendedTypesJOW

fullyQualifiedName

java.lang.String fullyQualifiedName

This field is identical to NestedType.nameWithContainer, but also has the Package-Name prepended to it, if the Package-Name was present in the enclosing class' '.java' file.

EXAMPLE: For Java java.util.Map.Entry<K, V>, the fullyQualifiedName would be "java.util.Map.Entry".

genericTypeParameters

java.lang.String[] genericTypeParameters

implementedTypesJOW

java.lang.String[] implementedTypesJOW

nameWithContainer

java.lang.String nameWithContainer

The name-field (Declaration.name) of this class uses the lone Java-Identifier (Just One Word) which identifies this NestedClass within the scope of the enclosing class. However, nameWithContainer is a String that also includes any / all enclosing-class names, each followed-by a '.'

EXAMPLE: For Java java.util.Map.Entry<K, V>, the nameWithContainer would be "Map.Entry".

Generic Type-Parameter information is not included in this String, and neither is the Package-Name.

numFields

int numFields

The number of fields that are defined in this inner-type

numMethods

int numMethods

The number of methods defined in this inner-type

packageName

java.lang.String packageName

The name of the package in which the enclosing-class of this nested-type is defined. This field will be null if the package was not found, or left blank as the 'default class'.

Class Torello.JavaDoc.ParsedFile extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

annotationElems

java.util.Vector<AnnotationElem> annotationElems

This is the list of AnnotationElem instances identified by the parser for this ParsedFile

annotationsMirror

Torello.JavaDoc.Annotations.AnnotationsMirror annotationsMirror

Stores information provided by the JavaDoc Upgrader Annotations. Note, this Annotation Mirror does not contain information about any / all annotations used inside of Java Source Code Files, but rather only the ones created by this API.

These include @StaticFunctional and also @JDHeaderBackgroundImg

ciet

CIET ciet

The acronym 'CIET' simply means "Class, Interface or Enumerated-Type. This public field identifies whether this ParsedFile is for a class, an interface or an enumerated-type.

constructors

java.util.Vector<Constructor> constructors

This is the list of Constructor instances identified by the parser for this ParsedFile

containerClasses

java.lang.String[] containerClasses

This identifies inner classes and interfaces. For any class that is not an inner class, this will be a zero-length String[] array.

'containerClasses' Value	Input CIET
{ }	interface java.lang.Integer
{ }	class java.util.Vector<E>
{ "Base64" }	class java.util.Base64.Decoder
{ "Map" }	interface java.util.Map.Entry<K, V>

See Also:

ParsedFile.getContainerClasses()

endLineNumber

int endLineNumber

The line-number in the source-code file where this class definition ends. Often this will just be the line-number of the last line in the '.java' file.

If this is a Nested-Type, this field will contain the line-number where the definition of the Nested-type ends.

enumConstants

java.util.Vector<EnumConstant> enumConstants

This is the list of EnumConstant instances identified by the parser for this ParsedFile

See Also:

ParsedFile.enumConstants

fields

java.util.Vector<Field> fields

This is the list of Field instances identified by the parser for this ParsedFile

fileName

java.lang.String fileName

Contains the file-name from which this instance was derived

fullyQualifiedName

java.lang.String fullyQualifiedName

This holds the fully qualified CIET name - which means that package and containing class information is included. If thi CIET is a Java Generic that happens to have Generic Type Parameters (the 'E' in Vector<E>, this name WILL NOT include that text.

For Instance:

Input CIET	'fullyQualifiedName' Field Value
interface java.lang.Integer	"java.lang.Integer"
class java.util.Vector<E>	"java.util.Vector"
class java.util.Base64.Decoder	"java.util.Base64.Decoder"
interface java.util.Map.Entry<K, V>	"java.util.Map.Entry"

See Also:

ParsedFile.simpleName, ParsedFile.name

genericParameters

java.util.Vector<java.lang.String> genericParameters

If this represents a Java Generic Class or Interface, with generic type information, the generic type parameters shall be saved here.

See Also:

ParsedFile.getGenericParameters()

isGeneric

boolean isGeneric

This field will be TRUE anytime the ParsedFile.genericParameters field has any elements.

isInner

boolean isInner

This identifies inner classes and interfaces.

'isInner' Field Value	Input CIET
false	interface java.lang.Integer
false	class java.util.Vector<E>
true	class java.util.Base64.Decoder
true	interface java.util.Map.Entry<K, V>

javaSrcFileAsStr

java.lang.String javaSrcFileAsStr

This field simply contains the entire contents of the '.java' Source-Code File from whence this ParsedFile instance originated.

Note that for in for the sub-class JavaDocHTMLFile, when the HTML file which was parsed represents an inner-class / nested-type, this field will still contain the entire contents of the top-level enclosing java type (as a String) in this field.

For instance, if a JavaDocHTMLFile (which inherits this class, ParsedFile) instance had been generated for the Java-HTML inner-class Torello.HTML.Attributes.Filter, which happens to be a nested type of class Torello.HTML.Attributes, this field would contain the text-characters of the Source-File Torello/HTML/Attributes.java in String-format (as character data).

jdEndLineNumber

int jdEndLineNumber

The endiing line-number of the JavaDoc Comment at the top of the class. If this class does not have a Java-Doc Comment, this field will contain -1.

jdStartLineNumber

int jdStartLineNumber

The starting line-number of the JavaDoc Comment at the top of the class. If this class does not have a Java-Doc Comment, this field will contain -1.

methods

java.util.Vector<Method> methods

This is the list of Method instances identified by the parser for this ParsedFile

name

java.lang.String name

Holds the name. A 'ParsedFile' represents a class, interface, or enumerated-type. This name is NOT the fully-qualified (package-included) name, and it will have any Generic Type Parameters appended, if this CIET represents a generic that has type-parameters.

If this CIET is an inner-class, the containing CIET name is included in this String field.

For Instance:

Input CIET	'name' Field Value
interface java.lang.Integer	"Integer"
class java.util.Vector<E>	"Vector<E>"
class java.util.Base64.Decoder	"Base.Decoder"
interface java.util.Map.Entry<K, V>	"Map.Entry<K, V>"

See Also:

ParsedFile.simpleName, ParsedFile.fullyQualifiedName

nestedTypes

java.util.Vector<NestedType> nestedTypes

This is the list of NestedType instances identified by the parser for this ParsedFile

packageName

java.lang.String packageName

Holds the package-name. If this ParsedFile were for class java.lang.String the 'packageName' would be 'java.lang'.

simpleName

java.lang.String simpleName

This the same as the ParsedFile.name parameter, but leaves off both the type-parameters, and the fully-qualified package-name String's. If this CIET is an inner class the containing CIET name is included in this String field. See the table below, for details:

Input CIET	'simpleName' Field Value
interface java.lang.Integer	"Integer"
class java.util.Vector<E>	"Vector"
class java.util.Base64.Decoder	"Base64.Decoder"
interface java.util.Map.Entry<K, V>	"Map.Entry"

See Also:

ParsedFile.name, ParsedFile.fullyQualifiedName

startLineNumber

int startLineNumber

The line-number in the source-code file where this class definition actually begins.

Note that if this instance of ParsedFile is representing a Nessted-Type / Inner-Class, then this field will contain the line-number where that inner-type's definition begins inside the Enclosing-Class' '.java' file.

typeLineCount

int typeLineCount

The number of lines of Source-Code inside this '.java' File. If this instance of ParsedFile represents an Inner-Type (Nested-Class), then this field will contain a value that corresponds only to the number of lines used by the Nested-Type within the context of the entire Enclosing-Class '.java' file.

typeSizeChars

int typeSizeChars

The number of characters / bytes of Source-Code inside this '.java' File. If this instance of ParsedFile represents an Inner-Type (Nested-Class), then this field will contain a value that corresponds only to the number of characters / bytes used by the Nested-Type within the context of the entire Enclosing-Class '.java' file.

Class Torello.JavaDoc.ParseException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

signature

java.lang.String signature

This public, final String should contain the exact method, constructor or field-variable that was being parsed when the exception threw. In the event that this information is unknown, a polite message indicating as such will be saved to this field.

Class Torello.JavaDoc.ReflHTML extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

descFromTypeLabel

boolean descFromTypeLabel

This boolean indicates that the HTML description provided by this JavaDoc Detail has been copied from an parent-class or from an interface. In cases where an abstract method is implemented, the programmer may "opt-out" of typing anything about what the method's purpose is. If so, JavaDoc automatically copies the abstract (or parent) method's description, and leaves a little note saying so.

Note that when this occurs, there will by two HTML <DIV CLASS="block"> elements on the page for that detail.

entity

ENTITY extends Declaration entity

This is the actual type-reflection (type-mirror) of the Entity extracted from the Java Doc '.html' web-page file, and from the '.java' Source Code File.

Since the type-parameter ENTITY must extend Declaration, this field will hold all of the information that was parsed & extracted by Java Parser. Depending on what type of instance of Declaration this represents, this will field will contain all of the parameter-names, parameter-types, modifiers, and exceptions that are associated with the entity.

This will take one of five type's: Method, Constructor, Field, EnumConstant, AnnotationElem. This allows you to retrieve all reflected information, quickly and easily, associated with the Java Doc HTML "Detail Section" for a particular method, field, constructor etc...

entityAsEnum

Entity entityAsEnum

This is used as a 'faster-way' to retrieve what type of Entity this "Reference-HTML" detail-section is being represented here. This makes the code more readable than using Java's 'getClass()' reflection to identify whether this 'Detail Section HTML' holds the HTML for a Method, Field, Constructor, Enumeration, etc...

The value in 'entityAsEnum' shall always be identical to the type of the ReflHTML.entity. So for instance, if ReflHTML.entity contained a Field instance, this field would be equal to Entity.FIELD. If this entity represented a Method HTML Detail-Section element, then this field would hold Entity.METHOD.

hiLitedCode

Replaceable hiLitedCode

htmlID

java.lang.String htmlID

Each Deteail Entity on a JavaDoc Page has a small and empty Anchor-Link, with an ID Attribute that allows the browser to redirect to the detail on a JavaDoc page using a relative URL to redirect to the details location on the web-page. If that detail element was found, it's will be stored in this field. (Otherwise, this field will contain null)

Below is the <A ID=..> generated by Java Doc for a method that is named 'length', and takes zero parameters as input.

<a id="length()"> <!-- --> </a>

location

DotPair location

miscSimpleTagLabels

java.util.ArrayList<TagNodeIndex> miscSimpleTagLabels

name

SubSection name

needToAddOpenCloseDLsForHiLitedDetails

boolean needToAddOpenCloseDLsForHiLitedDetails

openingUL

TagNodeIndex openingUL

This points to the opening <UL> tag for the detail. It's contents may be modified to include CSS classes or id's.

signature

SubSection signature

subSections

java.util.TreeMap<java.lang.Character,SubSection> subSections

Class Torello.JavaDoc.SourceCodeParseException extends ParseException implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.Stats extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

globalTagsCount

java.util.Map<java.lang.String,java.lang.Integer> globalTagsCount

globalTagsMap

java.util.Map<java.lang.String,java.lang.String> globalTagsMap

LAST_USED_packageName

java.lang.String LAST_USED_packageName

LAST_USED_packageStats

Stats LAST_USED_packageStats

numAnnotationElems

int numAnnotationElems

numBytes

int numBytes

numConstructors

int numConstructors

numDocumentedAnnotationElems

int numDocumentedAnnotationElems

numDocumentedConstructors

int numDocumentedConstructors

numDocumentedEnumConstants

int numDocumentedEnumConstants

numDocumentedFields

int numDocumentedFields

numDocumentedMethods

int numDocumentedMethods

numEnumConstants

int numEnumConstants

numFields

int numFields

numFinalConstructors

int numFinalConstructors

numFinalFields

int numFinalFields

numFinalMethods

int numFinalMethods

numHiLitedAnnotationElems

int numHiLitedAnnotationElems

numHiLitedConstructors

int numHiLitedConstructors

numHiLitedDivs

int numHiLitedDivs

numHiLitedEnumConstants

int numHiLitedEnumConstants

numHiLitedFields

int numHiLitedFields

numHiLitedMethods

int numHiLitedMethods

numLines

int numLines

numMethods

int numMethods

numPrivateConstructors

int numPrivateConstructors

numPrivateFields

int numPrivateFields

numPrivateMethods

int numPrivateMethods

numProtectedConstructors

int numProtectedConstructors

numProtectedFields

int numProtectedFields

numProtectedMethods

int numProtectedMethods

numPublicConstructors

int numPublicConstructors

numPublicFields

int numPublicFields

numPublicMethods

int numPublicMethods

numStaticFields

int numStaticFields

numStaticMethods

int numStaticMethods

numTransientFields

int numTransientFields

numVolatileFields

int numVolatileFields

packageName

java.lang.String packageName

packageStatsMap

java.util.Map<java.lang.String,Stats> packageStatsMap

packageTagsCount

java.util.Map<java.lang.String,java.lang.Integer> packageTagsCount

packageTagsMap

java.util.Map<java.lang.String,java.lang.String> packageTagsMap

Class Torello.JavaDoc.SummaryTableException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class Torello.JavaDoc.UpgradeException extends java.lang.IllegalArgumentException implements Serializable

serialVersionUID:

1L