General

java.lang.Object
- com.screenscraper.util.General

public class General
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class General.CursorChanger

static class General.StringBrowserDisplayer

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`General.CursorChanger`
`static class`	`General.StringBrowserDisplayer`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`BYTES_IN_A_MEGABYTE` The number of bytes in a megabyte.
`static java.lang.String`	`CRLF`
`static byte[]`	`EMPTY_BYTE_ARRAY`
`static java.lang.String[]`	`EMPTY_STRING_ARRAY`
`static java.lang.String[][]`	`EMPTY_STRING_ARRAY_2D`
`static java.lang.String`	`EOF`
`static long`	`IL`
`static java.lang.Class[]`	`parameters` Holds classes for the classpath.
`static boolean`	`RUN_SHUTDOWN_HOOK` Indicates whether or not the shutdown hook should be run on exit.
`static java.lang.String`	`SECOND_INSTANCE_ERROR_MESSAGE` The message to be given when a second instance of screen-scraper attempts to start up and we are going to exit.
`static java.lang.String`	`SECOND_INSTANCE_ERROR_MESSAGE_CONTINUE_ANYWAY` The message to be given when a second instance of screen-scraper attempts to start up and we are going to allow the user to proceed anyway.
`static java.lang.String`	`VARIABLE_BEGIN_DELIMITER`
`static java.lang.String`	`VARIABLE_END_DELIMITER`
`static long`	`VL`
`static java.lang.String`	`WORKING_DIR` The current working directory.

Constructor Summary

Constructors
Constructor and Description

General()

Constructors
Constructor and Description
`General()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addShutdownHook()` Ensures that things get cleaned up, even if the app is interrupted.
`static java.lang.String`	`adjustNewlines(java.lang.String input)` Normalizes newline symbols in a string to a canonical form.
`static boolean`	`applicationIsOpen(java.lang.String fileLockName)` Indicates whether or not an instance of the server or workbench are open.
`static boolean`	`areMultipleApplicationsOpen()` Indicates whether or not multiple applications are open (e.g., the workbench and the server).
`static int`	`booleanToInt(boolean value)` Turns a boolean value into an int, for storage in the database.
`static boolean`	`characterReaderContainsString(java.io.Reader reader, java.lang.String val)` Checks the given reader of characters for a specific string.
`static void`	`cleanUpCommandLineLockFiles()` Deletes any lock files that have been queued for deletion.
`static boolean`	`commandLineIsOpen(boolean considerMultiple)` Checks to see if an instance of the command line is already open.
`static int`	`compareToUpperCase(java.lang.String string1, java.lang.String string2)` Compare the uppercase compareTo values of two strings Note that this is to be used with strings pulled from JTextArea widgets, which don't properly take into account hard returns when giving selection locations.
`static boolean`	`contains(java.lang.String searchString, java.lang.String regularExpression)` Indicates whether or not the given `String` contains the given regular expression.
`static java.lang.String`	`convertHTMLEntities(java.lang.String val)` Replaces HTML entities in a string with their non-entity equivalents.
`static int`	`countMatchesSubString(java.lang.String haystack, java.lang.String needle, int limit)` Counts the number of sub-strings within a string up to a certain point in the original string.
`static java.lang.String`	`decode(java.lang.String url)` This is just a wrapper to URLDecoder.decode() that catches any errors while encoding
`static java.lang.String`	`decode(java.lang.String url, java.lang.String characterSet)` This is just a wrapper to URLDecoder.decode() that catches any errors while encoding
`static byte[]`	`decompressGzipStream(java.io.InputStream inputStream, int maxKBytes)` Decompresses a GZIP stream, returning the resulting bytes.
`static byte[]`	`decompressZlibContent(byte[] content)` Decompresses an array of bytes in zlib format.
`static void`	`deleteCacheDatabase()` Removes the cache database from the file system.
`static void`	`deleteDeleteMeFile()` Deletes the "delete_me.htm" file.
`static java.util.HashMap`	`deriveDaysHoursMinutesSecondsFromMilliseconds(long millis)` Derives the number of days, hours, minutes, and seconds from a long representing a number of milliseconds.
`static void`	`displayStringInLocalWebBrowser(java.lang.String html, java.lang.String url)` Displays the HTML in the string in a local web browser.
`static void`	`displayValueInTextArea(java.lang.String value)` Displays a value in a text area.
`static void`	`doFullHotSwapFromDatabase()` Does a hot swap from the database.
`static void`	`doFullHotSwapFromFiles()` Does a hot swap for both scripts and scraping sessions.
`static void`	`dumpFileContentsToLog(java.io.File file)` Dumps the contents of a file to the log.
`static void`	`dumpMemoryUsage()` Writes out to the log information relating to the applications current use of memory.
`static java.lang.String`	`encode(java.lang.String str, java.lang.String characterSet)` This is just a wrapper to URLEncoder.encode() that catches any errors while encoding
`static void`	`ensureLocksFolderExists()` Ensures that the locks folder exists.
`static boolean`	`equalsUpperCase(java.lang.String string1, java.lang.String string2)` Compare the uppercase values of two strings
`static java.lang.String`	`escapeSpaces(java.lang.String string)` Replaces space characters with %20.
`static java.lang.String`	`expressionize(java.lang.String contents, ExtractorPattern extractorPattern)` Converts an extractor pattern so it is ready to run as a regular expression
`static java.lang.String`	`generateDebuggingInformation()` Generates an output string containing data about the threads in the JVM.
`static int`	`getAvailablePort()` Returns a port that is currently open.
`static int`	`getAvailablePort(java.lang.String startPort)` Gets a port available on the system.
`static java.awt.Point`	`getCenteredPoint(java.awt.Component component)` This method returns the point a component, like a dialog, should be placed on the screen based on the components length and width so that it is centerd.
`static long`	`getCheckSum(java.io.File file)` Gets the checksum for a file.
`static java.lang.String`	`getCurrentlySelectedHTML(javax.swing.JEditorPane editorPane, java.lang.String originalText, int selectionThreshold)` Gets the currently selected HTML.
`static java.lang.String`	`getCurrentYear()` Gets the current year, as a string.
`static java.lang.String[]`	`getDefaultCharacterSets()` Gets an array containing default character sets.
`static java.util.List<java.lang.String>`	`getDefaultScriptImports()` Returns the list of imports that are used for every script (Java language).
`static java.lang.String`	`getDefaultScriptImportStatement()` Returns the import statement that will be used on all scripts.
`static java.awt.Frame`	`getFrame(java.awt.Component component)` Given a `Component`, this method will ascend through the component hierarchy until it hits a `Frame`.
`static java.util.Map<java.lang.String,java.lang.Object>`	`getGlobalInstanceVariables()` Returns a `ConcurrentHashMap` of instance-wide variables that can be used in all scrapes.
`static java.lang.String`	`getGUID()` Gets the GUID for this installation.
`static ScrapingHttpClient`	`getHttpClient()` Gets a basic HttpClient.
`static org.apache.http.conn.routing.HttpRoute`	`getHttpRouteFromGeneralSettings(org.apache.http.HttpHost target, org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context, ScrapingSession scrapingSession)` Sets proxy server settings based on the local proxy configuration.
`static java.lang.String`	`getHumanReadableRepresentationOfMilliseconds(long time)` Gets a human-readable representation of an amount of time in milliseconds.
`static java.util.Set<java.io.File>`	`getImportableFiles(java.lang.Class<?> type)` Looks for importable files in the "import" directory.
`static int`	`getIntForObject(java.lang.Object value)` Returns an int for a `Object`.
`static java.io.File`	`getLastSelectedDirectory()` Gets the last directory selected from a `JFileChooser`.
`static java.lang.String`	`getMimeType(java.io.File file)` Gets the MIME-type for a file.
`static java.lang.String`	`getMimeTypeThrowable(java.io.File file)` Gets the MIME-type for a file throwing an exception if a problem occurs.
`static int`	`getNumMatches(java.lang.String stringToSearch, java.lang.String stringToFind, boolean isCaseSensitive)` Determines the number of times one string is found in another, allowing for case sensitivity.
`static int`	`getNumStringsWithinString(java.lang.String needle, java.lang.String haystack)` Gets the number of strings within a string as matched by a regular expression.
`static java.lang.String`	`getPathForURL(java.net.URL url)` Gets the path portion of a URL.
`static int`	`getPortFromSetting(java.lang.String port)` Gets a port based on the setting provided.
`static java.lang.String`	`getQueryString(java.net.URL url)` Gets the query string portion of a URL.
`static java.lang.String`	`getUUID()` Gets a UUID.
`static java.util.HashSet<java.lang.String>`	`getVariableNames(java.lang.String value)` Extracts variable names from a `String`.
`static boolean`	`hasWriteAccess()` Indicates whether or not we have write access to certain critical files.
`static boolean`	`hasWriteAccess(java.io.File file)` Checks for write access to a specific file.
`static boolean`	`httpResponseIsInGzipFormat(org.apache.http.HttpResponse httpResponse)` Indicates whether or not the method's response is in GZIP format.
`static boolean`	`installIncludesJVM()` Indicates whether or not the installation includes a JVM.
`static boolean`	`intToBoolean(int value)` Turns an int value into a boolean, for retrieval from database.
`static boolean`	`ipAddressAllowedToConnect(java.lang.String ipAddress)` Determines whether or not the given IP address should be allowed to connect.
`static boolean`	`isAnyApplicationOpen()` Indicates if any application is currently open.
`static boolean`	`isInt(java.lang.String string)` Indicates whether or not the given `String` can be parsed as an int.
`static boolean`	`isNullOrEmptyString(java.lang.Object object)` Indicates whether or not an object is either null or an empty string.
`static boolean`	`isPlatformAIX()` Indicates whether or not we're running on AIX.
`static boolean`	`isPlatformLinux()` Indicates whether or not we're running on linux.
`static boolean`	`isPlatformMac()` Indicates whether or not we're running on a Mac.
`static boolean`	`isPlatformWindows()` Indicates whether or not we're running on Windows.
`static boolean`	`isRunningInWorkbench()` Returns whether or not we are currently running in the workbench.
`static int`	`lessThanZeroToZero(int num)` Converts a number less than 0 to 0.
`static long`	`lessThanZeroToZero(long num)` Converts a number less than 0 to 0.
`static void`	`lockCommandLine()` Obtains a lock for this particular command line instance.
`static void`	`lockFile(java.lang.String fileLockName)` Locks the file with the given name, if possible.
`static void`	`lockServer()` Obtains a lock on the server.
`static void`	`lockWorkbench()` Obtains a lock on the workbench.
`static void`	`logSystemProperties()` Outputs all system properties to the log.
`static void`	`main(java.lang.String[] args)` Just a little convenience method used to get the checksum for a file.
`static java.lang.String`	`makeDELETERequest(java.lang.String urlString, java.util.Map<java.lang.String,java.lang.String> headers, ScrapingSession session)` Makes a DELETE request.
`static java.lang.String`	`makeGETRequest(java.lang.String urlString)` Makes a GET request and returns the result as a string.
`static java.lang.String`	`makeGETRequest(java.lang.String urlString, int attempts)` Makes a GET request and returns the result as a string.
`static java.lang.String`	`makeGETRequest(java.lang.String urlString, ScrapingSession session)` Makes a GET request and returns the result as a string.
`static java.lang.String[][]`	`makeHEADRequest(java.lang.String urlString, ScrapingSession session)` Makes a HEAD request and returns the headers in a two-deminsional array.
`static java.lang.String`	`makePUTRequest(java.lang.String urlString, java.util.Map<java.lang.String,java.lang.String> headers, ScrapingSession session)` Makes a PUT request.
`static boolean`	`methodResponseIsInGzipFormat(org.apache.commons.httpclient.HttpMethodBase method)` Indicates whether or not the method's response is in GZIP format.
`static void`	`notifyOfCorruptDatabase()` Notifies the user that the database is corrupted.
`static void`	`notifyOfWriteFileError(java.lang.String files)` Notifies the user that they don't have write access to needed files.
`static void`	`notifyUserOfComplexHTML(javax.swing.JComponent component)` If, when trying to get the currently selected HTML, we're unable to for some reason this method will notify the user.
`static java.lang.String`	`nullToEmptyString(java.lang.Object value)` Turns a potentially null value into an empty string.
`static boolean`	`objectNameIsValid(java.lang.String name)` Validates that the given `String` represents a valid name for a `ScrapingSession`.
`static void`	`openURLInNativeBrowser(java.lang.String url)` Displays a URL in the local native web browser.
`static void`	`ph()` Phones home.
`static java.lang.String`	`prepareStringForDatabase(java.lang.String value)` If the given string is null this method will simply return null back; otherwise, it will return the string properly escaped and surrounded by single-quotes to prepare it to be inserted into the database.
`static void`	`queueCleanUpCommandLineLockFiles()` Cleans up any old command line lock files.
`static byte[]`	`readContentFromHttpMethodBase(org.apache.commons.httpclient.HttpMethodBase method, int maxKBytes)` Reads in content from an `HttpMethodBase` and returns a byte array containing the content.
`static byte[]`	`readContentFromHttpResponse(org.apache.http.HttpResponse httpResponse, int maxKBytes, boolean decompressContent)` Reads in content from an `HttpResponse` and returns a byte array containing the content.
`static byte[]`	`readStreamIntoByteArray(java.io.InputStream stream)` Reads a stream into a byte array.
`static java.lang.String`	`replace(java.lang.String regularExpression, java.lang.String substitution, java.lang.String searchedString)` Finds and replaces a string using a regular expression.
`static java.lang.String`	`replaceInvalidCharactersInURL(java.lang.String url)` HttpClient doesn't like pipes in URL's, but it seems to work to replace the pipes with forward slashes, so this method handles that.
`static void`	`replaceStringWithinFile(java.lang.String find, java.lang.String replace, java.io.File inFile)` Replaces all instances of one string for another within a file.
`static boolean`	`serverIsOpen()` Checks to see if an instance of the server is already open.
`static void`	`setFrameLocation(java.awt.Component frame, int x, int y)` Sets the location of the frame to the given location, ensuring it is at least partway visible on a screen
`static void`	`setFrameLocation(java.awt.Component frame, java.awt.Point location)` Sets the location of the frame to the given location, ensuring it is at least partway visible on a screen
`static void`	`setLastSelectedDirectory(java.io.File lastSelectedDirectory)` Sets the last directory selected from a `JFileChooser`.
`static void`	`setMacSystemProperties()` Sets Mac-specific system properties.
`static void`	`setProxySettingsOnHttpClient(org.apache.commons.httpclient.HttpClient client, org.apache.commons.httpclient.HostConfiguration hostConfiguration)` Sets proxy settings on the client using the default proxy settings.
`static void`	`setRequiredSystemProperties()` Sets system properties needed globally.
`static void`	`setupMozilla()` Sets up the Mozilla stuff.
`static void`	`showBusyCursor(java.awt.Component component)` Changes the cursor to a busy cursor.
`static void`	`showCursor(java.awt.Component component, int cursor)` Changes the cursor to the given cursor.
`static void`	`showDefaultCursor(java.awt.Component component)` Changes the cursor to the default cursor.
`static boolean`	`startsWithUpperCase(java.lang.String string1, java.lang.String string2)` Compare the uppercase startsWith values of two strings
`static java.lang.String`	`stripHTML(java.lang.String content)` Strips HTML from a string, replacing some tags with corresonding text-only equivalents.
`static java.lang.String`	`stripHTMLComments(java.lang.String html)` Strips HTML comments from a string.
`static java.lang.String`	`stripUnnecessaryWhiteSpace(java.lang.String input)` Strips off all \t, \r, and \n characters..
`static java.lang.String`	`swapExtractorPatternTokensForEmbeddedSessionVariables(java.lang.String value)` Swaps any extractor pattern tokens (e.g., ~@FOO@~) for embedded session variables (e.g., ~#FOO#~).
`static void`	`tele()` Phone home in a separate thread.
`static boolean`	`testPorts()` Ensures that all needed ports are available, and notifies the user, if not.
`static java.lang.String`	`tidyHTML(java.lang.String html, java.lang.String characterSet, int tidyHTMLType)` Tidies up the HTML string.
`static java.lang.String`	`trimIfNotNull(java.lang.String str)` Trims a string if it's not null; returns null, otherwise.
`static boolean`	`valEA(java.lang.String ea)` Validates that an email address is registered.
`static void`	`valEANoGUI()` Validates a license without using anything graphical.
`static long`	`validate()` Used to validate whether or not the license is valid.
`static void`	`waitForApplicationToClose()` In the case of two applications closing at about the same time this method causes one application to wait until the other finishes first.
`static boolean`	`workbenchIsOpen()` Checks to see if an instance of the workbench is already open.
`static void`	`writeDataToFile(java.lang.String data, java.io.File file)` Write the `String` out to a file.
`static void`	`writeValueToFile(java.lang.Object value, java.lang.String file, java.lang.String charSet)` Writes a value to a file using the given character set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- EMPTY_BYTE_ARRAY
```
public static final byte[] EMPTY_BYTE_ARRAY
```
- EMPTY_STRING_ARRAY
```
public static final java.lang.String[] EMPTY_STRING_ARRAY
```
- EMPTY_STRING_ARRAY_2D
```
public static final java.lang.String[][] EMPTY_STRING_ARRAY_2D
```
- VARIABLE_BEGIN_DELIMITER
```
public static final java.lang.String VARIABLE_BEGIN_DELIMITER
```
  See Also:
  
  Constant Field Values
- VARIABLE_END_DELIMITER
```
public static final java.lang.String VARIABLE_END_DELIMITER
```
  See Also:
  
  Constant Field Values
- CRLF
```
public static final java.lang.String CRLF
```
  See Also:
  
  Constant Field Values
- EOF
```
public static final java.lang.String EOF
```
  See Also:
  
  Constant Field Values
- WORKING_DIR
```
@Nullable
public static java.lang.String WORKING_DIR
```
  The current working directory.
- SECOND_INSTANCE_ERROR_MESSAGE
```
@NotNull
public static java.lang.String SECOND_INSTANCE_ERROR_MESSAGE
```
  The message to be given when a second instance of screen-scraper attempts to start up and we are going to exit.
- SECOND_INSTANCE_ERROR_MESSAGE_CONTINUE_ANYWAY
```
@NotNull
public static java.lang.String SECOND_INSTANCE_ERROR_MESSAGE_CONTINUE_ANYWAY
```
  The message to be given when a second instance of screen-scraper attempts to start up and we are going to allow the user to proceed anyway.
- VL
```
public static final long VL
```
  See Also:
  
  Constant Field Values
- IL
```
public static final long IL
```
  See Also:
  
  Constant Field Values
- parameters
```
public static final java.lang.Class[] parameters
```
  Holds classes for the classpath.
- BYTES_IN_A_MEGABYTE
```
public static final long BYTES_IN_A_MEGABYTE
```
  The number of bytes in a megabyte.
  
  See Also:
  
  Constant Field Values
- RUN_SHUTDOWN_HOOK
```
public static boolean RUN_SHUTDOWN_HOOK
```
  Indicates whether or not the shutdown hook should be run on exit.

Constructor Detail
- General
```
public General()
```

Method Detail

getGlobalInstanceVariables
```
@NotNull
public static java.util.Map<java.lang.String,java.lang.Object> getGlobalInstanceVariables()
```
Returns a ConcurrentHashMap of instance-wide variables that can be used in all scrapes. Note that this map can cause memory leaks (eg a scrape adds to it but doesn't clean up what it adds, causing the instance to hold onto that memory until the next restart). Be sure that you clean up anything you add to this map unless you need it to still be there later.

Returns:

The map of global variables to use across multiple scraping sessions

prepareStringForDatabase
```
@Nullable
public static java.lang.String prepareStringForDatabase(@Nullable
                                                                   java.lang.String value)
```
If the given string is null this method will simply return null back; otherwise, it will return the string properly escaped and surrounded by single-quotes to prepare it to be inserted into the database.

Parameters:

value - The String to be prepared.

Returns:

The string, prepared for the database

nullToEmptyString
```
public static java.lang.String nullToEmptyString(@Nullable
                                                 java.lang.Object value)
```
Turns a potentially null value into an empty string. This function is to be used when submitting information to a database so that an empty string gets submitted instead of the word "null". Also handles escaping out any quotes.

Parameters:

value - A String that may be null.

Returns:

An empty string if the value is null, the original string, otherwise.

booleanToInt
```
public static int booleanToInt(boolean value)
```
Turns a boolean value into an int, for storage in the database.

Parameters:

value - The boolean value.

Returns:

A 1 if the boolean is true, 0 if false.

intToBoolean
```
public static boolean intToBoolean(int value)
```
Turns an int value into a boolean, for retrieval from database.

Parameters:

value - The int value.

Returns:

Returns true if the int is greater than 0, false otherwise.

trimIfNotNull

@Nullable
public static java.lang.String trimIfNotNull(@Nullable
                                                        java.lang.String str)

Trims a string if it's not null; returns null, otherwise.

Parameters:: str - The string to trim.
Returns:: The trimmed string.

isNullOrEmptyString

public static boolean isNullOrEmptyString(@Nullable
                                          java.lang.Object object)

Indicates whether or not an object is either null or an empty string.

Parameters:: object - The Object to test.
Returns:: A boolean.

getIntForObject
```
public static int getIntForObject(java.lang.Object value)
```
Returns an int for a Object. Will return -1 if the object can't be parsed.

Parameters:

value - The value to parse.

Returns:

The integer value for the object

replace

@Nullable
public static java.lang.String replace(@Nullable
                                                  java.lang.String regularExpression,
                                                  @Nullable
                                                  java.lang.String substitution,
                                                  @Nullable
                                                  java.lang.String searchedString)

Finds and replaces a string using a regular expression.

Parameters:: regularExpression - The regular expression to search for.; substitution - The text to substitute in.; searchedString - The string to search.
Returns:: The searchedString after the search and replace has been performed.

contains
```
public static boolean contains(@NotNull
                               java.lang.String searchString,
                               java.lang.String regularExpression)
```
Indicates whether or not the given String contains the given regular expression.

Parameters:

searchString - A String to search.

regularExpression - A String representing a regular expression.

Returns:

A boolean.

getFrame
```
public static java.awt.Frame getFrame(java.awt.Component component)
```
Given a Component, this method will ascend through the component hierarchy until it hits a Frame. This method is used so that various cursors can be displayed and so that dialog boxes can be made modal.

Parameters:

component - A Component.

Returns:

The Frame.

showBusyCursor
```
public static void showBusyCursor(java.awt.Component component)
```
Changes the cursor to a busy cursor.

Parameters:

component - Some Componentwithin the hierarchy.

showDefaultCursor
```
public static void showDefaultCursor(java.awt.Component component)
```
Changes the cursor to the default cursor.

Parameters:

component - Some Componentwithin the hierarchy.

getDefaultScriptImports
```
@NotNull
public static java.util.List<java.lang.String> getDefaultScriptImports()
```
Returns the list of imports that are used for every script (Java language).

Returns:

The list of imports added automatically to each script

getDefaultScriptImportStatement
```
@NotNull
public static java.lang.String getDefaultScriptImportStatement()
```
Returns the import statement that will be used on all scripts. This method is used so the string only needs to be built once

Returns:

The import statement that will be used on all scripts. This method is used so the string only needs to be built once

setFrameLocation

public static void setFrameLocation(@NotNull
                                    java.awt.Component frame,
                                    @NotNull
                                    java.awt.Point location)

Sets the location of the frame to the given location, ensuring it is at least partway visible on a screen

Parameters:: frame - The frame; location - The new location desired

setFrameLocation

public static void setFrameLocation(@NotNull
                                    java.awt.Component frame,
                                    int x,
                                    int y)

Sets the location of the frame to the given location, ensuring it is at least partway visible on a screen

Parameters:: frame - The frame; x - The new x coordinate desired; y - The new y coordinate desired

showCursor
```
public static void showCursor(java.awt.Component component,
                              int cursor)
```
Changes the cursor to the given cursor.

Parameters:

component - Some Componentwithin the hierarchy.

cursor - The cursor position

expressionize

@Nullable
 @Contract(value="null, !null -> null; !null, !null -> !null")
public static java.lang.String expressionize(@Nullable
                                                                                                                        java.lang.String contents,
                                                                                                                        @NotNull
                                                                                                                        ExtractorPattern extractorPattern)

Converts an extractor pattern so it is ready to run as a regular expression

Parameters:: contents - The contents of the expression, including the token names; extractorPattern - The extractor pattern
Returns:: A regular expression for matching the extractor

stripUnnecessaryWhiteSpace

@Nullable
 @Contract(value="null -> null; !null -> !null")
public static java.lang.String stripUnnecessaryWhiteSpace(@Nullable
                                                                                                                       java.lang.String input)

Strips off all \t, \r, and \n characters..

Parameters:: input - String to strip white space from.
Returns:: String with all unnecessary white space stripped.

adjustNewlines
```
public static java.lang.String adjustNewlines(@NotNull
                                              java.lang.String input)
```
Normalizes newline symbols in a string to a canonical form. The newline symbols that are searched for are "\r", "\n", and "\r\n".

Parameters:

input - String to normalize newlines for

Returns:

String representing the input string with all newline symbols replaced by the desired newline string.

stripHTMLComments

@Nullable
 @Contract(value="null -> null; !null -> !null")
public static java.lang.String stripHTMLComments(@Nullable
                                                                                                              java.lang.String html)

Strips HTML comments from a string.

Parameters:: html - A string containing HTML.
Returns:: The string with the HTML comments stripped out.

stripHTML

@Nullable
 @Contract(value="null -> null; !null -> !null")
public static java.lang.String stripHTML(@Nullable
                                                                                                      java.lang.String content)

Strips HTML from a string, replacing some tags with corresonding text-only equivalents.

Parameters:: content - The content to be stripped.
Returns:: The stripped content.

getVariableNames

@NotNull
public static java.util.HashSet<java.lang.String> getVariableNames(@Nullable
                                                                             java.lang.String value)

Extracts variable names from a String.

Parameters:: value - The string the variable names are to be extracted from.
Returns:: A HashSet containing the variable names.

getCenteredPoint
```
public static java.awt.Point getCenteredPoint(@NotNull
                                              java.awt.Component component)
```
This method returns the point a component, like a dialog, should be placed on the screen based on the components length and width so that it is centerd.

Parameters:

component - Component to find the centerd location for.

Returns:

The point that centers the component.

getQueryString

@Nullable
public static java.lang.String getQueryString(@Nullable
                                                         java.net.URL url)

Gets the query string portion of a URL.

Parameters:: url - The URL that may contain a query string.
Returns:: The query string if it exists; null, otherwise.

getPathForURL

public static java.lang.String getPathForURL(@Nullable
                                             java.net.URL url)

Gets the path portion of a URL.

Parameters:: url - The URL.
Returns:: The path portion of the URL.

escapeSpaces
```
@Nullable
public static java.lang.String escapeSpaces(java.lang.String string)
```
Replaces space characters with %20.

Parameters:

string - The string to fix.

Returns:

The fixed string.

equalsUpperCase

public static boolean equalsUpperCase(@Nullable
                                      java.lang.String string1,
                                      @Nullable
                                      java.lang.String string2)

Compare the uppercase values of two strings

Parameters:: string1 - The string1 to compare.; string2 - The string2 to compare.
Returns:: The boolean if the uppercase of the strings equals

startsWithUpperCase

public static boolean startsWithUpperCase(@Nullable
                                          java.lang.String string1,
                                          @Nullable
                                          java.lang.String string2)

Compare the uppercase startsWith values of two strings

Parameters:: string1 - The string1 to compare.; string2 - The string2 to compare.
Returns:: The boolean if the startsWith uppercase of the strings equals

compareToUpperCase
```
public static int compareToUpperCase(@Nullable
                                     java.lang.String string1,
                                     @Nullable
                                     java.lang.String string2)
```
Compare the uppercase compareTo values of two strings Note that this is to be used with strings pulled from JTextArea widgets, which don't properly take into account hard returns when giving selection locations.

Parameters:

string1 - The string1 to compare.

string2 - The string2 to compare.

Returns:

int of uppercase values of compareTo

countMatchesSubString

public static int countMatchesSubString(@Nullable
                                        java.lang.String haystack,
                                        @Nullable
                                        java.lang.String needle,
                                        int limit)

Counts the number of sub-strings within a string up to a certain point in the original string.

Parameters:: haystack - The string to search; needle - The string to find; limit - the maximum number of times to find the string
Returns:: The number of sub-strings.

getCurrentlySelectedHTML

@Nullable
public static java.lang.String getCurrentlySelectedHTML(@Nullable
                                                                   javax.swing.JEditorPane editorPane,
                                                                   @Nullable
                                                                   java.lang.String originalText,
                                                                   int selectionThreshold)

Gets the currently selected HTML.

Parameters:: editorPane - The JEditorPane from which the selected HTML should be drawn.; originalText - The original text being selected from. This is needed in the event that more than one match is found.; selectionThreshold - Determines the buffer on either side of a selected block of text that will comprise an extractor pattern, when requested.
Returns:: The HTML block.

notifyUserOfComplexHTML
```
public static void notifyUserOfComplexHTML(javax.swing.JComponent component)
```
If, when trying to get the currently selected HTML, we're unable to for some reason this method will notify the user.

Parameters:

component - The JComponent the dialog box needs to be modal to.

isRunningInWorkbench
```
public static boolean isRunningInWorkbench()
```
Returns whether or not we are currently running in the workbench. This is a convenience method for doing something different in a script when running in the workbench as opposed to the other modes.

Returns:

True iff the scrape is currently running in the workbench

tidyHTML

@Nullable
public static java.lang.String tidyHTML(@Nullable
                                                   java.lang.String html,
                                                   @Nullable
                                                   java.lang.String characterSet,
                                                   int tidyHTMLType)

Tidies up the HTML string.

Parameters:: html - The string of HTML to tidy.; characterSet - The character set to use when tidying.; tidyHTMLType - The type of tidying to be done, as defined by the "TIDY_HTML" constants found in the Settings class.
Returns:: The tidied HTML.

isAnyApplicationOpen
```
public static boolean isAnyApplicationOpen()
```
Indicates if any application is currently open.

Returns:

A boolean.

areMultipleApplicationsOpen
```
public static boolean areMultipleApplicationsOpen()
```
Indicates whether or not multiple applications are open (e.g., the workbench and the server). This is used to determine whether or not is safe to shutdown the database.

Returns:

A boolean.

workbenchIsOpen
```
public static boolean workbenchIsOpen()
```
Checks to see if an instance of the workbench is already open.

Returns:

A boolean.

lockWorkbench
```
public static void lockWorkbench()
```
Obtains a lock on the workbench.

serverIsOpen
```
public static boolean serverIsOpen()
```
Checks to see if an instance of the server is already open.

Returns:

A boolean.

lockServer
```
public static void lockServer()
```
Obtains a lock on the server.

commandLineIsOpen
```
public static boolean commandLineIsOpen(boolean considerMultiple)
```
Checks to see if an instance of the command line is already open.

Parameters:

considerMultiple - A boolean indicating whether or not we care whether two or more are open, or just one.

Returns:

A boolean.

queueCleanUpCommandLineLockFiles
```
public static void queueCleanUpCommandLineLockFiles()
```
Cleans up any old command line lock files.

cleanUpCommandLineLockFiles
```
public static void cleanUpCommandLineLockFiles()
```
Deletes any lock files that have been queued for deletion.

lockCommandLine
```
public static void lockCommandLine()
```
Obtains a lock for this particular command line instance.

ensureLocksFolderExists
```
public static void ensureLocksFolderExists()
```
Ensures that the locks folder exists.

applicationIsOpen
```
public static boolean applicationIsOpen(java.lang.String fileLockName)
```
Indicates whether or not an instance of the server or workbench are open.

Parameters:

fileLockName - The name of the file lock to check for.

Returns:

A boolean.

waitForApplicationToClose
```
public static void waitForApplicationToClose()
```
In the case of two applications closing at about the same time this method causes one application to wait until the other finishes first.

lockFile
```
public static void lockFile(java.lang.String fileLockName)
```
Locks the file with the given name, if possible.

Parameters:

fileLockName - The name of the file lock to check for.

deleteDeleteMeFile
```
public static void deleteDeleteMeFile()
```
Deletes the "delete_me.htm" file.

logSystemProperties
```
public static void logSystemProperties()
```
Outputs all system properties to the log.

dumpFileContentsToLog

public static void dumpFileContentsToLog(@NotNull
                                         java.io.File file)

Dumps the contents of a file to the log.

Parameters:: file - The file to read.

validate
```
public static long validate()
```
Used to validate whether or not the license is valid. If this is the first time ever this method is called the current date will be inserted into the database so that the trial expire date can later be calculated.

Returns:

A long representing the date the license will expire, if the app is currently being run as a trial version, a 0 if the license is valid, or a -1 if it is invalid.

valEANoGUI
```
public static void valEANoGUI()
```
Validates a license without using anything graphical. Checks an email address in a register.txt file.

valEA
```
public static boolean valEA(java.lang.String ea)
```
Validates that an email address is registered.

Parameters:

ea - The email address.

Returns:

True on valid email address

ipAddressAllowedToConnect

public static boolean ipAddressAllowedToConnect(@NotNull
                                                java.lang.String ipAddress)

Determines whether or not the given IP address should be allowed to connect.

Parameters:: ipAddress - The IP address.
Returns:: True if the ip address can connect

isInt
```
public static boolean isInt(@NotNull
                            java.lang.String string)
```
Indicates whether or not the given String can be parsed as an int.

Parameters:

string - The String to check.

Returns:

A boolean.

dumpMemoryUsage
```
public static void dumpMemoryUsage()
```
Writes out to the log information relating to the applications current use of memory.

installIncludesJVM
```
public static boolean installIncludesJVM()
```
Indicates whether or not the installation includes a JVM.

Returns:

A boolean.

getCheckSum

public static long getCheckSum(@NotNull
                               java.io.File file)

Gets the checksum for a file.

Parameters:: file - The file.
Returns:: The checksum.

getLastSelectedDirectory
```
@Nullable
public static java.io.File getLastSelectedDirectory()
```
Gets the last directory selected from a JFileChooser.

Returns:

A File.

setLastSelectedDirectory
```
public static void setLastSelectedDirectory(java.io.File lastSelectedDirectory)
```
Sets the last directory selected from a JFileChooser.

Parameters:

lastSelectedDirectory - A File.

writeDataToFile

public static void writeDataToFile(@NotNull
                                   java.lang.String data,
                                   @NotNull
                                   java.io.File file)

Write the String out to a file.

Parameters:: data - The String to write.; file - The File to write to.

objectNameIsValid

public static boolean objectNameIsValid(@NotNull
                                        java.lang.String name)

Validates that the given String represents a valid name for a ScrapingSession.

Parameters:: name - The proposed name.
Returns:: A boolean.

getImportableFiles
```
@NotNull
public static java.util.Set<java.io.File> getImportableFiles(java.lang.Class<?> type)
```
Looks for importable files in the "import" directory.

Parameters:

type - The class of objects desired (either ScrapingSession or Script.

Returns:

A HashSet containing File objects representing either ScrapingSession objects or Script objects. Note that an empty HashSet will be returned if no importable objects are found.

doFullHotSwapFromFiles
```
public static void doFullHotSwapFromFiles()
```
Does a hot swap for both scripts and scraping sessions.

doFullHotSwapFromDatabase
```
public static void doFullHotSwapFromDatabase()
```
Does a hot swap from the database.

setupMozilla
```
public static void setupMozilla()
```
Sets up the Mozilla stuff.

addShutdownHook
```
public static void addShutdownHook()
```
Ensures that things get cleaned up, even if the app is interrupted.

httpResponseIsInGzipFormat

public static boolean httpResponseIsInGzipFormat(@NotNull
                                                 org.apache.http.HttpResponse httpResponse)

Indicates whether or not the method's response is in GZIP format.

Parameters:: httpResponse - The HTTP response to examine.
Returns:: A boolean.

readContentFromHttpResponse

public static byte[] readContentFromHttpResponse(@NotNull
                                                 org.apache.http.HttpResponse httpResponse,
                                                 int maxKBytes,
                                                 boolean decompressContent)
                                          throws java.io.IOException

Reads in content from an HttpResponse and returns a byte array containing the content.

Parameters:: httpResponse - The HttpResponse.; maxKBytes - The maximum number of kilobytes to read.; decompressContent - Decompress the content, if necessary.
Returns:: A byte array.
Throws:: java.io.IOException - On error reading the response

methodResponseIsInGzipFormat

public static boolean methodResponseIsInGzipFormat(@NotNull
                                                   org.apache.commons.httpclient.HttpMethodBase method)

Indicates whether or not the method's response is in GZIP format.

Parameters:: method - The method to examine.
Returns:: A boolean.

readContentFromHttpMethodBase

public static byte[] readContentFromHttpMethodBase(@NotNull
                                                   org.apache.commons.httpclient.HttpMethodBase method,
                                                   int maxKBytes)
                                            throws java.io.IOException

Reads in content from an HttpMethodBase and returns a byte array containing the content.

Parameters:: method - The HttpMethodBase.; maxKBytes - The maximum number of kilobytes to read.
Returns:: A byte array.
Throws:: java.io.IOException - On error reading data

readStreamIntoByteArray

public static byte[] readStreamIntoByteArray(@NotNull
                                             java.io.InputStream stream)

Reads a stream into a byte array.

Parameters:: stream - An InputStream.
Returns:: An array of bytes containing the content.

deleteCacheDatabase
```
public static void deleteCacheDatabase()
```
Removes the cache database from the file system.

writeValueToFile

public static void writeValueToFile(@NotNull
                                    java.lang.Object value,
                                    @NotNull
                                    java.lang.String file,
                                    @Nullable
                                    java.lang.String charSet)
                             throws java.lang.Exception

Writes a value to a file using the given character set. If no character set is given the default character set defined in the "Settings" dialog box will be used.

Parameters:: value - The string to be written.; file - The name of the file.; charSet - The character set to use.
Throws:: java.lang.Exception - On error writing data

displayValueInTextArea
```
public static void displayValueInTextArea(java.lang.String value)
```
Displays a value in a text area.

Parameters:

value - The bytes to display.

getHttpRouteFromGeneralSettings

public static org.apache.http.conn.routing.HttpRoute getHttpRouteFromGeneralSettings(@NotNull
                                                                                     org.apache.http.HttpHost target,
                                                                                     org.apache.http.HttpRequest request,
                                                                                     @NotNull
                                                                                     org.apache.http.protocol.HttpContext context,
                                                                                     @Nullable
                                                                                     ScrapingSession scrapingSession)

Sets proxy server settings based on the local proxy configuration. To be used with HttpClient 4.

Parameters:: target - The host target; request - The request issued; context - The context of the request; scrapingSession - The scraping session for the request
Returns:: A boolean indicating whether or not a proxy was set.

setProxySettingsOnHttpClient

public static void setProxySettingsOnHttpClient(@NotNull
                                                org.apache.commons.httpclient.HttpClient client,
                                                @NotNull
                                                org.apache.commons.httpclient.HostConfiguration hostConfiguration)

Sets proxy settings on the client using the default proxy settings. DEPRECATED ONCE WE UPGRADED TO HttpClient 4.4.

Parameters:: client - The client to set the settings on.; hostConfiguration - The host configuration to set the settings on.

testPorts
```
public static boolean testPorts()
```
Ensures that all needed ports are available, and notifies the user, if not.

Returns:

false if at least one of the ports couldn't be bound to.

getAvailablePort
```
public static int getAvailablePort(@Nullable
                                   java.lang.String startPort)
```
Gets a port available on the system.

Parameters:

startPort - Starts at this port, and increments till it finds an available one.

Returns:

An available port

getPortFromSetting
```
public static int getPortFromSetting(java.lang.String port)
```
Gets a port based on the setting provided.

Parameters:

port - The port, which likely comes from the settings file. If the value for this parameter is "dynamic" a port will be found for it.

Returns:

The port number from a setting

replaceInvalidCharactersInURL

@Nullable
 @Contract(value="null -> null; !null -> !null")
public static java.lang.String replaceInvalidCharactersInURL(@Nullable
                                                                                                                          java.lang.String url)

HttpClient doesn't like pipes in URL's, but it seems to work to replace the pipes with forward slashes, so this method handles that.

Parameters:: url - The URL that may contain pipes.
Returns:: The string with the pipes replaced.

tele
```
public static void tele()
```
Phone home in a separate thread.

ph
```
public static void ph()
```
Phones home.

getGUID
```
public static java.lang.String getGUID()
```
Gets the GUID for this installation.

Returns:

The GUID.

getUUID

@NotNull
public static java.lang.String getUUID()

Gets a UUID.

Returns:: The UUID as a string.

getCurrentYear
```
@Nullable
public static java.lang.String getCurrentYear()
```
Gets the current year, as a string.

Returns:

The current year.

deriveDaysHoursMinutesSecondsFromMilliseconds
```
@NotNull
public static java.util.HashMap deriveDaysHoursMinutesSecondsFromMilliseconds(long millis)
```
Derives the number of days, hours, minutes, and seconds from a long representing a number of milliseconds.

Parameters:

millis - The number of milliseconds

Returns:

A HashMap containing the four "REPEAT_" params, identified by the constants in WebConstants.

openURLInNativeBrowser

public static void openURLInNativeBrowser(@NotNull
                                          java.lang.String url)

Displays a URL in the local native web browser.

Parameters:: url - The URL to display, as a String.

displayStringInLocalWebBrowser

public static void displayStringInLocalWebBrowser(@Nullable
                                                  java.lang.String html,
                                                  java.lang.String url)

Displays the HTML in the string in a local web browser.

Parameters:: html - The HTML to be displayed.; url - The original URL pointing to the page.

convertHTMLEntities

@Nullable
public static java.lang.String convertHTMLEntities(@Nullable
                                                              java.lang.String val)

Replaces HTML entities in a string with their non-entity equivalents.

Parameters:: val - The string containing the entities.
Returns:: The string with the entities replaced out.

characterReaderContainsString

public static boolean characterReaderContainsString(@NotNull
                                                    java.io.Reader reader,
                                                    @NotNull
                                                    java.lang.String val)

Checks the given reader of characters for a specific string.

Parameters:: reader - A Reader used to reader the characters.; val - The string to check for.
Returns:: A boolean indicating whether or not the string is found.

isPlatformAIX
```
public static boolean isPlatformAIX()
```
Indicates whether or not we're running on AIX.

Returns:

A boolean.

isPlatformLinux
```
public static boolean isPlatformLinux()
```
Indicates whether or not we're running on linux.

Returns:

A boolean.

isPlatformMac
```
public static boolean isPlatformMac()
```
Indicates whether or not we're running on a Mac.

Returns:

A boolean.

isPlatformWindows
```
public static boolean isPlatformWindows()
```
Indicates whether or not we're running on Windows.

Returns:

A boolean.

setRequiredSystemProperties
```
public static void setRequiredSystemProperties()
```
Sets system properties needed globally. These may be vendor specific for the JRE, but on the given vendor they are required for various reasons, such as SSL or other reasons.

setMacSystemProperties
```
public static void setMacSystemProperties()
```
Sets Mac-specific system properties.

hasWriteAccess
```
public static boolean hasWriteAccess()
                              throws java.lang.RuntimeException
```
Indicates whether or not we have write access to certain critical files.

Returns:

A boolean.

Throws:

java.lang.RuntimeException - An exception whose message contains a comma-delimited list of files the current user doesn't have write access to.

hasWriteAccess

public static boolean hasWriteAccess(@NotNull
                                     java.io.File file)

Checks for write access to a specific file.

Parameters:: file - The File to check.
Returns:: A boolean.

notifyOfWriteFileError
```
public static void notifyOfWriteFileError(java.lang.String files)
```
Notifies the user that they don't have write access to needed files.

Parameters:

files - The list of files to which they don't have write access.

notifyOfCorruptDatabase
```
public static void notifyOfCorruptDatabase()
```
Notifies the user that the database is corrupted.

makeHEADRequest

@NotNull
public static java.lang.String[][] makeHEADRequest(@Nullable
                                                             java.lang.String urlString,
                                                             @Nullable
                                                             ScrapingSession session)
                                                      throws java.lang.Exception

Makes a HEAD request and returns the headers in a two-deminsional array.

Parameters:: urlString - The URL to request, as a string.; session - An optional session object to use for its HttpClient object.
Returns:: The resulting headers.
Throws:: java.lang.Exception - If anything naughty happens.

makeDELETERequest

public static java.lang.String makeDELETERequest(@Nullable
                                                 java.lang.String urlString,
                                                 @Nullable
                                                 java.util.Map<java.lang.String,java.lang.String> headers,
                                                 @Nullable
                                                 ScrapingSession session)
                                          throws java.lang.Exception

Makes a DELETE request.

Parameters:: urlString - The URL to request, as a string.; session - An optional session object to use for its HttpClient object.; headers - An optional Map of request headers.
Returns:: The status line.
Throws:: java.lang.Exception - If anything naughty happens.

makePUTRequest

public static java.lang.String makePUTRequest(@Nullable
                                              java.lang.String urlString,
                                              @Nullable
                                              java.util.Map<java.lang.String,java.lang.String> headers,
                                              @Nullable
                                              ScrapingSession session)
                                       throws java.lang.Exception

Makes a PUT request.

Parameters:: urlString - The URL to request, as a string.; session - An optional session object to use for its HttpClient object.; headers - An optional Map of request headers.
Returns:: The status line.
Throws:: java.lang.Exception - If anything naughty happens.

getHttpClient
```
@NotNull
public static ScrapingHttpClient getHttpClient()
```
Gets a basic HttpClient. The user is responsible to close this client when they are done

Returns:

A CloseableHttpClient.

makeGETRequest
```
public static java.lang.String makeGETRequest(java.lang.String urlString)
                                       throws java.lang.Exception
```
Makes a GET request and returns the result as a string.

Parameters:

urlString - The URL to request, as a string. HttpClient object.

Returns:

The result of the request.

Throws:

java.lang.Exception - If anything naughty happens.

makeGETRequest

public static java.lang.String makeGETRequest(@NotNull
                                              java.lang.String urlString,
                                              int attempts)
                                       throws java.io.IOException

Makes a GET request and returns the result as a string.

Parameters:: urlString - The URL to request, as a string. HttpClient object.; attempts - The maximum number of times to attempt requesting the URL
Returns:: The result of the request.
Throws:: java.io.IOException - If anything naughty happens.

makeGETRequest

public static java.lang.String makeGETRequest(@Nullable
                                              java.lang.String urlString,
                                              @Nullable
                                              ScrapingSession session)
                                       throws java.lang.Exception

Makes a GET request and returns the result as a string.

Parameters:: urlString - The URL to request, as a string.; session - An optional session object to use for its HttpClient object.
Returns:: The result of the request.
Throws:: java.lang.Exception - If anything naughty happens.

encode

@Nullable
public static java.lang.String encode(@Nullable
                                                 java.lang.String str,
                                                 @Nullable
                                                 java.lang.String characterSet)

This is just a wrapper to URLEncoder.encode() that catches any errors while encoding

Parameters:: str - A string to URL-encode; characterSet - The character set to use when encoding.
Returns:: The encoded string.

decode
```
public static java.lang.String decode(@NotNull
                                      java.lang.String url)
```
This is just a wrapper to URLDecoder.decode() that catches any errors while encoding

Parameters:

url - a String the url to decode

Returns:

String the decoded url as a String

decode

public static java.lang.String decode(@NotNull
                                      java.lang.String url,
                                      @Nullable
                                      java.lang.String characterSet)

This is just a wrapper to URLDecoder.decode() that catches any errors while encoding

Parameters:: url - a String the url to decode; characterSet - The character set to use when encoding.
Returns:: String the decoded url as a String

getMimeTypeThrowable
```
public static java.lang.String getMimeTypeThrowable(java.io.File file)
                                             throws java.lang.Exception
```
Gets the MIME-type for a file throwing an exception if a problem occurs.

Parameters:

file - The File.

Returns:

A MIME-type. If something goes wrong null is returned.

Throws:

java.lang.Exception - On error finding a MIME Type

getMimeType
```
public static java.lang.String getMimeType(java.io.File file)
```
Gets the MIME-type for a file.

Parameters:

file - The File.

Returns:

A MIME-type. If something goes wrong null is returned.

decompressZlibContent

@NotNull
public static byte[] decompressZlibContent(@NotNull
                                                     byte[] content)

Decompresses an array of bytes in zlib format.

Parameters:: content - An array of bytes in zlib format.
Returns:: A decompressed byte array.

decompressGzipStream
```
@NotNull
public static byte[] decompressGzipStream(java.io.InputStream inputStream,
                                                    int maxKBytes)
                                             throws java.lang.Exception
```
Decompresses a GZIP stream, returning the resulting bytes.

Parameters:

inputStream - The InputStream to decompress.

maxKBytes - The maximum number of kilobytes to read.

Returns:

The decompressed array of bytes.

Throws:

java.lang.Exception - On error decompressing the stream

lessThanZeroToZero
```
public static int lessThanZeroToZero(int num)
```
Converts a number less than 0 to 0.

Parameters:

num - An int.

Returns:

An int.

lessThanZeroToZero
```
public static long lessThanZeroToZero(long num)
```
Converts a number less than 0 to 0.

Parameters:

num - A long.

Returns:

A long.

getDefaultCharacterSets
```
public static java.lang.String[] getDefaultCharacterSets()
```
Gets an array containing default character sets.

Returns:

An array of strings.

getHumanReadableRepresentationOfMilliseconds
```
public static java.lang.String getHumanReadableRepresentationOfMilliseconds(long time)
```
Gets a human-readable representation of an amount of time in milliseconds.

Parameters:

time - The amount of time in milliseconds.

Returns:

A human-readable representation of the time.

swapExtractorPatternTokensForEmbeddedSessionVariables

@Nullable
public static java.lang.String swapExtractorPatternTokensForEmbeddedSessionVariables(@Nullable
                                                                                                java.lang.String value)

Swaps any extractor pattern tokens (e.g., ~@FOO@~) for embedded session variables (e.g., ~#FOO#~).

Parameters:: value - The value
Returns:: A string with the values swapped.

main
```
public static void main(java.lang.String[] args)
```
Just a little convenience method used to get the checksum for a file.

Parameters:

args - The command line arguments

getAvailablePort
```
public static int getAvailablePort()
```
Returns a port that is currently open. Note that the port is available at the time the method returns, but may not be by the time it is wanted.

Returns:

A port number not currently in use

replaceStringWithinFile

public static void replaceStringWithinFile(@NotNull
                                           java.lang.String find,
                                           @NotNull
                                           java.lang.String replace,
                                           @NotNull
                                           java.io.File inFile)

Replaces all instances of one string for another within a file.

Parameters:: find - The string to find. Can be a regex.; replace - The string to replace the found string with.; inFile - The file to replace within.

getNumStringsWithinString

public static int getNumStringsWithinString(@NotNull
                                            java.lang.String needle,
                                            @NotNull
                                            java.lang.String haystack)

Gets the number of strings within a string as matched by a regular expression.

Parameters:: needle - A regular expression.; haystack - The string to search.
Returns:: The number of strings matching needle in the haystack string

getNumMatches

public static int getNumMatches(@Nullable
                                java.lang.String stringToSearch,
                                @Nullable
                                java.lang.String stringToFind,
                                boolean isCaseSensitive)

Determines the number of times one string is found in another, allowing for case sensitivity.

Parameters:: stringToSearch - The string we're looking in.; stringToFind - The string we're looking for.; isCaseSensitive - Whether or not the search should be case sensitive.
Returns:: The number of matches found.

generateDebuggingInformation
```
public static java.lang.String generateDebuggingInformation()
```
Generates an output string containing data about the threads in the JVM. This is useful for debugging purposes. The format is designed to be user-readable but the output format may change between versions.

Returns:

A string of data about the state of the JVM threads and other debugging information

Since:

7.0.11a

Class General

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_BYTE_ARRAY

EMPTY_STRING_ARRAY

EMPTY_STRING_ARRAY_2D

VARIABLE_BEGIN_DELIMITER

VARIABLE_END_DELIMITER

CRLF

EOF

WORKING_DIR

SECOND_INSTANCE_ERROR_MESSAGE

SECOND_INSTANCE_ERROR_MESSAGE_CONTINUE_ANYWAY

VL

IL

parameters

BYTES_IN_A_MEGABYTE

RUN_SHUTDOWN_HOOK

Constructor Detail

General

Method Detail

getGlobalInstanceVariables

prepareStringForDatabase

nullToEmptyString

booleanToInt

intToBoolean

trimIfNotNull

isNullOrEmptyString

getIntForObject

replace

contains

getFrame

showBusyCursor

showDefaultCursor

getDefaultScriptImports

getDefaultScriptImportStatement

setFrameLocation

setFrameLocation

showCursor

expressionize

stripUnnecessaryWhiteSpace

adjustNewlines

stripHTMLComments

stripHTML

getVariableNames

getCenteredPoint

getQueryString

getPathForURL

escapeSpaces

equalsUpperCase

startsWithUpperCase

compareToUpperCase

countMatchesSubString

getCurrentlySelectedHTML

notifyUserOfComplexHTML

isRunningInWorkbench

tidyHTML

isAnyApplicationOpen

areMultipleApplicationsOpen

workbenchIsOpen

lockWorkbench

serverIsOpen

lockServer

commandLineIsOpen

queueCleanUpCommandLineLockFiles

cleanUpCommandLineLockFiles

lockCommandLine

ensureLocksFolderExists

applicationIsOpen

waitForApplicationToClose

lockFile

deleteDeleteMeFile

logSystemProperties

dumpFileContentsToLog

validate

valEANoGUI