Package Torello.Java

This package is largely a "helper & utility" package to the HTML scrape routines. 'FileRW' make forgetting about the file-system a lot easier. 'FileNode' loads the directory-tree of the underlying file-system into memory, and facilitates traversing that tree with anything from java.util.Vector to java.util.stream.Stream.

Code HiLiting, and the JavaDoc Tool polls a server called 'HiLite.ME' easily and automatically.. Much of the classes in this package wind up seeming like a series of "college notes" or possiblly "research notes" for familiarizing oneself with Java. The class 'EXCC' which may seem trivial, helps when a complex exception with a large 'cause chain' is thrown. The code itself is only around 20 lines of Java Code.

There are almost a dozen basic utility classes in this package. The String routines are copious enough to simplify some of the things that are done with HTML News pages. Two of them are created by Code Generators (StrIndexOf and StrTokIndexOf). If the number of methods provided seems superfluous, you don't have to use them. However, writing something once, so it may be forgotten is how to improve JAR libraries.

Class FileNode
Java Entity	Description
FileNodeFilter	A simple functional-interface (lambda) for filtering lists of FileNode
SearchAndPrint	A functional-interface for specifying a regular-expression, and how to print the results, to the GREP Tool
IOExceptionHandler	A functional-interface, used in case of IOException, to be used alongside the 'GREP' Tool
RTC<SOME_DATA_STRUCTURE>	This class actually extends the parent-type class VarType
FileNode	One of the flagship classes of Java HTML, FileNode loads a directory or directory-tree from a File-System into memory, and provides a thorough API for listing and analyzing its contents
FileTransfer	Operating-System independent utilities for moving, copying and deleting files, or an entire tree of files - using the FileNode class
GREP	A utility that attempts to mimic the UNIX command 'grep'
SED	Based on the UNIX 'SED' Command, this class updates files based on either String-Literal matches & replacements, or or Regular-Expression matches
Super String Theory
Java Entity	Description
StrFilter	A simple functional-interface that provides many 'builder' methods for creating standard Java Predicate's that operate on an Object's 'toString' method
StrCSV	A utility that builds Comma Separated Value String's (and can parse them as well)
StrCh	Class String-Character provides an exhaustive-combinatoric suite of methods that extend the basic Java String methods equals, contains, startsWith and endsWith, using Java char primitives as the comparator element
StrCmpr	Class String-Compare provides an exhaustive-combinatoric suite of methods that extend the basic Java String methods equals, contains, startsWith and endsWith
StrTokCmpr	Similar to class String-Compare, String-Token-Compare also provides an exhaustive suite of methods that extend the basic Java String methods equals, contains, startsWith and endsWith, but further allowing a user to specify the match-string boundary-characters
StrIndent	A class for indenting, unindenting and trimming textual-strings
StrIndexOf	This class builds upon the API that is provided by String indexOf to provide a larger collection of search routines for Java String's
StrTokIndexOf	The purpose of this class is to help find the location of Token-Matches inside of an input source-String
StringParse	A plethora of extensions to Java's String class
StrPrint	This class provides several String printing utilities such as abbreviation and list printing
StrReplace	An efficient way to replace multiple substring's, or single-characters, inside of a single Java String, in place, without rebuilding the returned String more than once
StrSource
Command Line
Java Entity	Description
GSUTIL	This class wraps the Google Cloud command-line tool 'gsutil', simply using the standard Java java.lang.Process object (in addition to Java HTML's OSResponse) thereby providing a simple Java-API for these operating-system calls
MSDOS	A great tool for invoking commands to an MS-DOS operating-system
Shell	A great tool for working with a UNIX operating-system, and invoking common UNIX commands - this class simply converts many of the old UNIX-BASH shell commands into a simple Java API
OSCommands	Root Ancestor / Parent Class for all Operating-System Execution Classes - including: MSDOS, Shell, GSUTIL etc
OSExtras	This class allows for the user to provide redirects, environment variables, and output/error unification (meaning the Standard-Output and Error-Output Streams are printed together, as if they were being printed to the terminal)
OSResponse	Class Operating-System Response does is used as a return record class for the Java HTML classes Shell, GSUTIL & MSDOS
Simple HiLiter
Java Entity	Description
HiLiteMe	Wraps a basic on-line syntax-hiliter named HiLite.ME (which, itself, wraps the on-line hiliter pygments.org)
HiLiteMe.Cache	A caching-system class that allows this tool to efficiently bypass calls to the server when an exact-copy of the hilited source-code already exists inside the cache
HiLiteMe.Params	Inner class for providing a list of parameters when hiliting multiple files on disk
Utilities
Java Entity	Description
C	A UNIX Terminal Color-Codes implementation for printing colored text to terminal
EXCC	'Exception Cause Chain' helps convert exception messages whose Throwable
FileRW	Operating-System independent File Read & Write utilities that reduce many common Java File I/O Commands to a single method invocation, focusing heavily on Java's Serialization feature
LFEC	Load File Exception Catch provides an eloquent way for printing standardized (consistent-looking) error messages to terminal if a data-file fails to load from the file-system, and subsequently halting the JVM - immediately
LFEC.GCSSB	The Google Cloud Server Storage Bucket extension of "Load File Exception Catch" does the work that LFEC does, but for GCS Storage Buckets, rather than operating system files
LV	The Loop-Variable End-Points class is used extensively throughout the Java-HTML Library for throwing properly formatted exception messages vis-a-vis loop variables
Q	The class 'Q' (Query) is an extremely simple debugging tool that is similar to an IDE's 'breakpoint' feature, but instead using terminal input
RegExFiles	A utility for saving Regular-Expressions in a text-file that may be lazily-loaded at run-time when needed
StorageWriter	A class that is nearly identical to the StringBuilder and / or StringWriter standard Java Classes
VarType<RET_DATA_STRUCTURE,INSERT_TYPE>	Provides any method the ability to provide its users the ability to choose what kind of data structure should be used for returning the method's results
Enums
Java Entity	Description
Country	An enumeration of countries in the world
Verbosity	A Java 'enum' that is used in several locations in the Java-HTML JAR Library to allow an end-user to request the quantity of text being produced by a tool or application
Exceptions
Java Entity	Description
CallableBodyException	This is an exception that occurs when parsing Java Method & Constructor Bodies for the JavaDoc Code-HiLiting Application; and it indicates that the method or constructor body passed to the code-hiliting mechanism is not properly formatted
DirExpectedException	Thrown when a FileNode operation has been invoked on an instance that represents an Operating-System File, but that invoked-method may only be applied to Operating-System Directory instances
EmptyListException	Intended to signal that a required-parameter or configuration has been passed a Data-Structure that is an empty or null list
FileExpectedException	Thrown when a FileNode operation has been invoked on an instance that represents an Operating-System Directory, but that invoked-method may only be applied to Operating-System File instances
FileNodeException	General purpose exception that may be used alongside class FileNode
FileSizeException	May be used to indicate that a data-file is too large to fit into an in-memory data-structure; or too big to adhere to any kind of model-constraints
NException	Throws when a Method's (or Constructor's) integer-valued parameter (often for parameters that are actually named 'n', representing a 'count' of some form or fasion) does not adhere to some of those Method's expectations or requirements
NoMatchException	When a String parsing method intends for a particular Regular-Expression to match a String, but the match fails, then this exception may be thrown
ParallelArrayException	This may be used to check that array have equal lengths - if two or more arrays are expected to be parallel, but their lengths are not equal, then this exception should be thrown
RegExException	General purpose exception that may be used when a Regular Expression fails
SameSourceAndTargetException	Thrown when a move or copy operation has specified identical source and target places on disk
StrCmprException	An exception that performs a little bit of passed-parameter checking for the class StrCmpr
StringFormatException	General purpose exception used for poorly formatted String's, or for any String that does not meet some (or any) expected design, protocol, format or criteria
ToDoException	This class is meant to inform a user that some code-exeuction path has a reached a point where the developer has not finished writing the Java that needs to run in order to complete whatever instructions the user is expecting to be run
VarTypeParamException	This Exception class is used internally for building Collection instances using the java.lang.reflect.* package more smoothly
WritableDirectoryException	Used by methods that accept 'target directory' parameters to validate that the parameter's contents actually point to a both valid and writable location on disk
Errors
Java Entity	Description
ArrayExpectedError	Used when a parameter accepts an intance of 'Object', but stipulates that this reference must be a reference to a primitive-array
CacheError	This error is thrown by the HiLiteMe.Cache class, and it could potentially be used for any type of Cache Error
ExceptionCheckError	This class inherits class 'Error' because it is intended to mean that a more serious problems has just occurred
UnreachableError	If a code-block that was theoretically unreachable is actually reached, this error is a great class to make use-of during any debugging-phase of the development-process