Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X Z 

A

accept(File, String) - Method in class com.xmlmind.util.GlobFilter
 
add(File, File) - Method in class com.xmlmind.util.Zip.Archive
add(File, File, boolean) - Method in class com.xmlmind.util.Zip.Archive
Adds specified file to the zip archive.
addAll(File, FilenameFilter, File) - Method in class com.xmlmind.util.Zip.Archive
Adds all files contained in specified directory to the zip archive.
addRewriteURIEntry(String, String) - Method in interface com.xmlmind.util.XMLResolver
Adds specified <rewriteURI> entry to the XML catalogs being used by this resolver.
ALL_ENCODING_DETECTORS - Static variable in class com.xmlmind.util.LoadText
A ready-to-use array containing all LoadText.EncodingDetectors.
append(T[], T) - Static method in class com.xmlmind.util.ArrayUtil
Inserts specified item in specified array at the end of specified array.
append(String[], String) - Static method in class com.xmlmind.util.StringList
Inserts a String as last item of a list of Strings.
Archive(ZipOutputStream) - Constructor for class com.xmlmind.util.Zip.Archive
Constructs a helper class which will allow to add files to the specified destination zip stream.
ArrayUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on arrays.
available() - Method in class com.xmlmind.util.Base64.InputStream
 

B

Base16 - Class in com.xmlmind.util
Base-16 encoder/decoder.
Base64 - Class in com.xmlmind.util
Base-64 encoder/decoder.
Base64.InputStream - Class in com.xmlmind.util
A filter input stream that decodes the base-64 encoded data obtained from its underlying InputStream.
Base64.OutputStream - Class in com.xmlmind.util
A filter output stream that encodes in base-64 the binary data passed to its underlying OutputStream.
begin() - Method in class com.xmlmind.util.ConsoleCapture
Start message redirection.
BOM_UTF16_BE - Static variable in class com.xmlmind.util.LoadText
The UTF-16BE BOM (Byte Order Mark).
BOM_UTF16_LE - Static variable in class com.xmlmind.util.LoadText
The UTF-16LE BOM (Byte Order Mark).
BOM_UTF8 - Static variable in class com.xmlmind.util.LoadText
The UTF-8 BOM (Byte Order Mark).
BROWSER_LANGUAGE - Static variable in class com.xmlmind.whc.Compiler
 

C

capitalize(String) - Static method in class com.xmlmind.util.StringUtil
Returns the specified string with its first character converted to upper case.
captureOutput(Process, String[]) - Static method in class com.xmlmind.util.SystemUtil
Captures output of specified newly started process (see SystemUtil.shellStart(String)).
captureOutput(Process, Console) - Static method in class com.xmlmind.util.SystemUtil
Captures output of specified newly started process (see SystemUtil.shellStart(String)).
CharSequenceUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on CharSequences.
checkedCreateNewFile(File) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.createNewFile() but raises an IOException if this method returns false.
checkedDelete(File) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.delete() but raises an IOException if this method returns false.
checkedList(File) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.list() but raises an IOException if this method returns null.
checkedList(File, FilenameFilter) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.list(FilenameFilter) but raises an IOException if this method returns null.
checkedListFiles(File) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.listFiles() but raises an IOException if this method returns null.
checkedListFiles(File, FilenameFilter) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.listFiles(FilenameFilter) but raises an IOException if this method returns null.
checkedListFiles(File, FileFilter) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.listFiles(FileFilter) but raises an IOException if this method returns null.
checkedMkdir(File) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.mkdir() but raises an IOException if this method returns false.
checkedMkdirs(File) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.mkdirs() but raises an IOException if this method returns false.
checkedRename(File, File) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.renameTo() but raises an IOException if this method returns false.
checkedSetLastModified(File, long) - Static method in class com.xmlmind.util.FileUtil
Like java.io.File.setLastModified() but raises an IOException if this method returns false.
checkEncoding(String) - Static method in class com.xmlmind.util.LoadText
Returns the canonical name of encoding if valid; null otherwise.
checkHTTPConnection(URLConnection) - Static method in class com.xmlmind.util.URLUtil
Checks that specified HTTP connection returned "200 OK".
checkId(String) - Static method in class com.xmlmind.util.XMLText
Equivalent to checkId(s, false, '_').
checkId(String, boolean, char) - Static method in class com.xmlmind.util.XMLText
Converts specified string to a valid, though not always unique, ID.
checkIsEmptyDir(File) - Static method in class com.xmlmind.util.FileUtil
Check whether if specified file exists, is a directory and is empty.
checkText(String) - Static method in class com.xmlmind.util.XMLText
Returns false if specified text contains non-XML characters.
clear() - Method in class com.xmlmind.util.LinearHashtable
 
clear() - Method in class com.xmlmind.util.Log
Removes all buffered items.
clone() - Method in class com.xmlmind.util.LinearHashtable
 
close() - Method in class com.xmlmind.util.Base64.InputStream
 
close() - Method in class com.xmlmind.util.Base64.OutputStream
 
close() - Method in class com.xmlmind.util.Zip.Archive
Closes both the underlying destination zip stream and its output stream.
collapseWhiteSpace(String) - Static method in class com.xmlmind.util.XMLText
Replaces successive XML space characters by a single space character (' ') then removes leading and trailing space characters if any.
com.xmlmind.util - package com.xmlmind.util
Utilities and helpers used by various XMLmind projects.
com.xmlmind.whc - package com.xmlmind.whc
This package contains the implementation of XMLmind Web Help Compiler.
COMPARATOR - Static variable in class com.xmlmind.util.URLUtil
A ready-to-use URLComparator.
compare(URL, URL) - Method in class com.xmlmind.util.URLUtil.URLComparator
 
compareTo(VersionNumber) - Method in class com.xmlmind.util.VersionNumber
 
compile(File[], File, File, File) - Method in class com.xmlmind.whc.Compiler
Convenience method equivalent to Compiler.compile(URL[], URL, URL, File), except that the arguments are Files and not URLs.
compile(URL[], URL, URL, File) - Method in class com.xmlmind.whc.Compiler
Compiles a Web Help application by ``decorating'' specified XHTML pages.
Compiler - Class in com.xmlmind.whc
The Web Help Compiler.
Compiler(Console) - Constructor for class com.xmlmind.whc.Compiler
Constructs a compiler.
compressWhiteSpace(String) - Static method in class com.xmlmind.util.XMLText
Replaces successive XML space characters ('\t', '\r', '\n', ' ') by a single space character (' ').
computeCRC(File) - Static method in class com.xmlmind.util.Zip
Utility: computes and returns the CRC-32 of specified file.
Console - Interface in com.xmlmind.util
Interface implemented by objects which are required to report information, warnings and non-fatal errors to the user.
console - Variable in class com.xmlmind.util.ConsoleCapture
The Console to which all the messages are redirected.
Console.MessageType - Enum in com.xmlmind.util
Message types.
ConsoleCapture - Class in com.xmlmind.util
Utility class allowing to redirect all the messages printed to System.out and System.err to a Console.
ConsoleCapture(Console) - Constructor for class com.xmlmind.util.ConsoleCapture
Constructs an utility object allowing to redirect all the messages printed to System.out and System.err to specified Console.
contains(V) - Method in class com.xmlmind.util.LinearHashtable
 
contains(String[], String) - Static method in class com.xmlmind.util.StringList
Tests if list strings contains String string.
containsGlobChar(String, boolean) - Static method in class com.xmlmind.util.GlobMatcher
Convenience method: returns true if specified string contains a special character ('?', '*', '[', '{'); returns false otherwise.
containsIgnoreCase(String[], String) - Static method in class com.xmlmind.util.StringList
Same as StringList.contains(java.lang.String[], java.lang.String) but string comparison is case-insensitive.
containsKey(K) - Method in class com.xmlmind.util.LinearHashtable
 
contentTypeToCharset(String) - Static method in class com.xmlmind.util.URLUtil
Returns the value of the charset parameter possibly found in specified content type.
contentTypeToMedia(String) - Static method in class com.xmlmind.util.URLUtil
Parses a content type such as "text/html; charset=ISO-8859-1" and returns the media type (for the above example "text/html").
copyBytes(InputStream, OutputStream) - Static method in class com.xmlmind.util.FileUtil
Copies input to output.
copyDir(File, File, boolean, Console) - Static method in class com.xmlmind.util.FileUtil
Recursively copies specified directory.
copyDir(File, File, boolean) - Static method in class com.xmlmind.util.FileUtil
Recursively copies specified directory.
copyElementsInto(V[]) - Method in class com.xmlmind.util.LinearHashtable
Copies the elements contained in this hashtable to the specified array.
copyFile(File, File, boolean, Console) - Static method in class com.xmlmind.util.FileUtil
Copies specified file (not a directory).
copyFile(File, File, boolean) - Static method in class com.xmlmind.util.FileUtil
Copies specified file (not a directory).
copyFile(File, File) - Static method in class com.xmlmind.util.FileUtil
Copies specified file (not a directory).
copyFile(URL, File) - Static method in class com.xmlmind.util.FileUtil
Copies the contents of specified URL to specified file.
copyFile(InputStream, File) - Static method in class com.xmlmind.util.FileUtil
Copies specified source to specified file.
copyFile(File, OutputStream) - Static method in class com.xmlmind.util.FileUtil
Copies specified file to specified destination.
copyFile(InputStream, OutputStream) - Static method in class com.xmlmind.util.FileUtil
Copies input to output.
copyFile(String, String) - Static method in class com.xmlmind.util.URLUtil
Copies the contents of specified URL to specified "file:" URL.
copyFileOrDir(File, File, boolean, Console) - Static method in class com.xmlmind.util.FileUtil
Copies specified file or directory.
copyFileOrDir(File, File, boolean) - Static method in class com.xmlmind.util.FileUtil
Copies specified file or directory.
copyKeysInto(K[]) - Method in class com.xmlmind.util.LinearHashtable
Copies the keys contained in this hashtable to the specified array.
create(String) - Static method in class com.xmlmind.util.GlobFilter
Convenience method: creates a filter for specified pattern, but unlike the constructor, this method does not raise an exception if this fails.
create(String) - Static method in class com.xmlmind.util.GlobMatcher
Convenience method: creates a matcher for specified pattern, but unlike the constructor, this method does not raise an exception if this fails.
createReader(InputStream, String, String[], LoadText.EncodingDetector...) - Static method in class com.xmlmind.util.LoadText
Creates a reader which can be used to read the contents of specified text source.
createRecorder(String) - Method in interface com.xmlmind.util.Log.RecorderFactory
Creates and returns the logger having specified name.
createRecorder(String) - Method in class com.xmlmind.util.Log.RecorderFactoryImpl
 
createTempDirectory(String, File) - Static method in class com.xmlmind.util.FileUtil
Create a temporary directory.
createURL(String) - Static method in class com.xmlmind.util.URLUtil
Same as new URL(spec), except that non-ASCII characters and other illegal characters such as spaces possibly found in spec are %HH-encoded.
createURL(URL, String) - Static method in class com.xmlmind.util.URLUtil
Same as new URL(context, spec), except that non-ASCII characters and other illegal characters such as spaces possibly found in spec are %HH-encoded.
createURL(URL, String, URLStreamHandler) - Static method in class com.xmlmind.util.URLUtil
Same as new URL(context, spec, handler), except that non-ASCII characters and other illegal characters such as spaces possibly found in spec are %HH-encoded.
CSS_CHARSET_DETECTOR - Static variable in class com.xmlmind.util.LoadText
A ready-to-use instance of KeywordBasedDetector("@charset") (CSS stylesheets).
currentWorkingDir() - Static method in class com.xmlmind.util.SystemUtil
Returns the absolute, canonical directory corresponding to system property user.dir (that is, the current working directory) if this directory exists.

D

date - Variable in class com.xmlmind.util.Log.Item
Date at which the message has been logged.
debug(String) - Method in class com.xmlmind.util.Log
Logs specified message at level Log.Level.DEBUG.
decode(String) - Static method in class com.xmlmind.util.Base16
Decodes base-16 encoded string.
decode(String, int) - Static method in class com.xmlmind.util.Base16
Same as Base16.decode(String), except that argument limt allows to limit the number of decoded bytes.
decode(String) - Static method in class com.xmlmind.util.Base64
Decodes base-64 encoded string.
decode(String, int) - Static method in class com.xmlmind.util.Base64
Same as Base64.decode(String), except that argument limit allows to limit the number of decoded bytes.
decode(String) - Static method in class com.xmlmind.util.URIComponent
Equivalent to decode(s, "UTF-8").
decode(String, String) - Static method in class com.xmlmind.util.URIComponent
Decodes all %HH sequences.
DEFAULT_CAPACITY - Static variable in class com.xmlmind.util.Log
Default buffering capacity (1,000).
defaultEncoding() - Static method in class com.xmlmind.util.SystemUtil
Returns the default character encoding for this platform.
defaultUserPreferencesDir() - Static method in class com.xmlmind.util.SystemUtil
deleteDir(File, Console) - Static method in class com.xmlmind.util.FileUtil
Deletes specified directory.
deleteDir(File) - Static method in class com.xmlmind.util.FileUtil
Deletes specified directory.
deleteFile(File, Console) - Static method in class com.xmlmind.util.FileUtil
Deletes specified file (not a directory).
deleteFile(File) - Static method in class com.xmlmind.util.FileUtil
Deletes specified file (not a directory).
deleteFileOrDir(File, Console) - Static method in class com.xmlmind.util.FileUtil
Deletes specified file or directory.
deleteFileOrDir(File) - Static method in class com.xmlmind.util.FileUtil
Deletes specified file or directory.
detailedReason(Throwable) - Static method in class com.xmlmind.util.ThrowableUtil
Equivalent to detailedReason(e, 1).
detailedReason(Throwable, int) - Static method in class com.xmlmind.util.ThrowableUtil
Same as ThrowableUtil.reason(java.lang.Throwable) except that the stack trace of specified exception is integrated to returned message.
detailedReason(Throwable, StringBuilder) - Static method in class com.xmlmind.util.ThrowableUtil
Copies both the message and the stack trace of specified exception to specified buffer.
detectEncoding(byte[], int, int[], LoadText.EncodingDetector...) - Static method in class com.xmlmind.util.LoadText
Detect encoding by examining specified bytes which have been read at the very start of a text file.
detectEncoding(String) - Method in interface com.xmlmind.util.LoadText.EncodingDetector
Parses specified few text lines and returns found encoding if any.
detectEncoding(String) - Method in class com.xmlmind.util.LoadText.EncodingDetectorBase
 
DOCUMENT_LANGUAGE - Static variable in class com.xmlmind.whc.Compiler
 
doDeleteFileOrDir(File) - Static method in class com.xmlmind.util.FileUtil
Deletes specified file or directory.
doEmptyDir(File) - Static method in class com.xmlmind.util.FileUtil
Removes all the files contained in specified directory.

E

elements() - Method in class com.xmlmind.util.LinearHashtable
 
EMACS_STYLE_DETECTOR - Static variable in class com.xmlmind.util.LoadText
A ready-to-use instance of LoadText.EmacsStyleDetector.
EmacsStyleDetector() - Constructor for class com.xmlmind.util.LoadText.EmacsStyleDetector
 
EMPTY_LIST - Static variable in class com.xmlmind.util.FileUtil
A ready-to-use empty list of Files.
EMPTY_LIST - Static variable in class com.xmlmind.util.StringList
A ready-to-use empty list of Strings.
EMPTY_LIST - Static variable in class com.xmlmind.util.StringUtil
A ready-to-use empty list of Strings.
EMPTY_LIST - Static variable in class com.xmlmind.util.URLUtil
A ready-to-use empty list of URLs.
emptyDir(File) - Static method in class com.xmlmind.util.FileUtil
Removes all the files contained in specified directory.
encode(byte[]) - Static method in class com.xmlmind.util.Base16
Encodes binary data to base-16.
encode(byte[]) - Static method in class com.xmlmind.util.Base64
Equivalent to encode(b, 76).
encode(byte[], int) - Static method in class com.xmlmind.util.Base64
Encodes binary data to base-64.
encode(String) - Static method in class com.xmlmind.util.URIComponent
Equivalent to encode(s, "UTF-8").
encode(String, String) - Static method in class com.xmlmind.util.URIComponent
Encodes non-ASCII characters, space characters (according to java.lang.Character.isSpaceChar) and control characters (according to java.lang.Character.isISOControl) as %XX bytes.
EncodingDetectorBase() - Constructor for class com.xmlmind.util.LoadText.EncodingDetectorBase
 
end() - Method in class com.xmlmind.util.ConsoleCapture
Stop message redirection and restore the real System.out and System.err.
endIndex - Variable in class com.xmlmind.util.RegexMatch
Index of the end of the input subsequence.
EntityResolverImpl - Class in com.xmlmind.whc
Not part of the public documented API: an entity resolver which substitutes any public XHTML DTD by just the definitions of all HTML character entities (e.g.
EntityResolverImpl(EntityResolver) - Constructor for class com.xmlmind.whc.EntityResolverImpl
 
entries() - Method in class com.xmlmind.util.LinearHashtable
Returns an Iterator over all the entries contained in this hashtable.
equals(Object) - Method in class com.xmlmind.util.GlobMatcher
 
equals(Object, Object) - Static method in class com.xmlmind.util.ObjectUtil
Tests if specified objects are equal using equals().
equals(Object) - Method in class com.xmlmind.util.VersionNumber
 
error(String) - Method in class com.xmlmind.util.Log
Logs specified message at level Log.Level.ERROR.
escape(String) - Static method in class com.xmlmind.util.StringUtil
Returns the specified string with all non-ASCII characters and non-printable ASCII characters replaced by the corresponding Java escape sequences (that is '\n', 'é', etc).
escape(String, StringBuilder) - Static method in class com.xmlmind.util.StringUtil
Same as StringUtil.escape(String) except that the escaped string is appended to specified buffer.
escape(char) - Static method in class com.xmlmind.util.StringUtil
Returns the \\uXXXX Java escape sequence corresponding to specified character.
escape(char, StringBuilder) - Static method in class com.xmlmind.util.StringUtil
Same as StringUtil.escape(char) expect that the \\uXXXX Java escape sequence is appended to specified buffer.
escapeXML(String) - Static method in class com.xmlmind.util.XMLText
Escapes specified string (that is, '<' is replaced by "&#60;", '&' is replaced by "&#38;", etc).
escapeXML(String, StringBuilder) - Static method in class com.xmlmind.util.XMLText
Escapes specified string (that is, '<' is replaced by "&#60;", '&' is replaced by "&#38;", etc).
escapeXML(char[], int, int, StringBuilder) - Static method in class com.xmlmind.util.XMLText
Escapes specified character array (that is, '<' is replaced by "&#60;", '&' is replaced by "&#38;", etc).
escapeXML(char[], int, int, StringBuilder, int) - Static method in class com.xmlmind.util.XMLText
Escapes specified character array (that is, '<' is replaced by "&#60;", '&' is replaced by "&#38;", etc).
exists(URL) - Static method in class com.xmlmind.util.URLUtil
Returns true if specified URL corresponds to an existing resource; returns false otherwise.

F

fileToURI(File) - Static method in class com.xmlmind.util.FileUtil
Similar to FileUtil.fileToURL(java.io.File), expect that it returns an URI.
fileToURL(File) - Static method in class com.xmlmind.util.FileUtil
Converts a File to a file: URL.
FileUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on Files.
filterText(String) - Static method in class com.xmlmind.util.XMLText
Returns a copy of specified text after removing all non-XML characters (if any).
find(T[], T) - Static method in class com.xmlmind.util.ArrayUtil
Searches specified array for specified item.
findAppInPath(String) - Static method in class com.xmlmind.util.SystemUtil
Searches specified application using the PATH environment variable.
finish() - Method in class com.xmlmind.util.Base64.OutputStream
Like Base64.OutputStream.close() but does not close the underlying output stream.
finish() - Method in class com.xmlmind.util.Zip.Archive
Closes the underlying destination zip stream without closing its output stream.
flush() - Method in class com.xmlmind.util.Base64.OutputStream
 
formatFileSize(long) - Static method in class com.xmlmind.util.FileUtil
formatFileSize(long, Locale) - Static method in class com.xmlmind.util.FileUtil
Returns a localized, formatted, form of specified file size.
fromString(String) - Static method in class com.xmlmind.util.VersionNumber
Equivalent to fromString(s, false).
fromString(String, boolean) - Static method in class com.xmlmind.util.VersionNumber
Parses specified string as a version number.

G

get(K) - Method in class com.xmlmind.util.IdentityLinearHashtable
 
get(K) - Method in class com.xmlmind.util.LinearHashtable
 
get() - Method in class com.xmlmind.util.Log
Returns all buffered items.
get(int) - Method in class com.xmlmind.util.Log
Returns last buffered items.
get(Log.Level) - Method in class com.xmlmind.util.Log
Returns all buffered items having at most specified level.
get(Log.Level, int) - Method in class com.xmlmind.util.Log
Returns last buffered items having at most specified level.
getAll() - Method in class com.xmlmind.util.Preferences
Returns all preferences in the form of a list of key/value pairs.
getAll(Matcher) - Static method in class com.xmlmind.util.RegexMatch
Returns all input subsequence captured during last match operation performed by specified matcher.
getBaseName(String) - Static method in class com.xmlmind.util.URIComponent
Same as URIComponent.getRawBaseName(java.lang.String) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getBaseName(URL) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.getRawBaseName(java.net.URL) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getBoolean(String, boolean) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getCapacity() - Method in class com.xmlmind.util.Log
Returns buffering capacity.
getClassPath(URL) - Static method in class com.xmlmind.util.JarUtil
Returns the URLs of the JARs listed in the Class-Path attribute of the manifest of a JAR.
getClassPathAttribute(URL) - Static method in class com.xmlmind.util.JarUtil
Returns the Class-Path attribute of the manifest of a JAR.
getCollapseTOC() - Method in class com.xmlmind.whc.Compiler
Returns true if the TOC is to be initially collapsed; otherwise returns false.
getColor(String, Color) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getConsole() - Method in class com.xmlmind.whc.Compiler
Returns the console used to display error, warning and progress messages.
getDefaultLanguage() - Method in class com.xmlmind.whc.Compiler
Returns the language used when the XHTML page being parsed does not specify a xml:lang or lang attribute on its html root element.
getDouble(String, double, double, double) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getDouble(String, double) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getDoubles(String, double[]) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getErrorLevel() - Method in class com.xmlmind.util.SimpleConsole
Returns the least severe message type displayed by this console.
getExtension(File) - Static method in class com.xmlmind.util.FileUtil
Returns the extension of specified file.
getExtension(String) - Static method in class com.xmlmind.util.FileUtil
Similar to FileUtil.getExtension(File) except that it acts on a filename rather than on a File.
getExtension(String) - Static method in class com.xmlmind.util.URIComponent
Same as URIComponent.getRawExtension(java.lang.String) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getExtension(URL) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.getRawExtension(java.net.URL) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getFont(String, Font) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getFragment(String) - Static method in class com.xmlmind.util.URIComponent
Same as URIComponent.getRawFragment(java.lang.String) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getFragment(URL) - Static method in class com.xmlmind.util.URLUtil
Same as URL.getRef except that the returned value is decoded using URIComponent.decode(java.lang.String).
getIdMapHref() - Method in class com.xmlmind.whc.Compiler
Returns the href value specified using Compiler.setIdMapHref(java.lang.String).
getIdMapIdPrefix() - Method in class com.xmlmind.whc.Compiler
Returns the ID prefix specified using Compiler.setIdMapIdPrefix(java.lang.String).
getIdMapTitle() - Method in class com.xmlmind.whc.Compiler
Returns the title value specified using Compiler.setIdMapTitle(java.lang.String).
getIndexNumbers() - Method in class com.xmlmind.whc.Compiler
Returns true if words looking like numbers are to be indexed; otherwise returns false.
getIndividualLanguageCode(Locale) - Static method in class com.xmlmind.util.LocaleUtil
Returns the lowercase ISO 639 code corresponding to the individual language of the specified locale.
getInt(String, int, int, int) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getInt(String, int) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getInts(String, int[]) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getJQuery() - Method in class com.xmlmind.whc.Compiler
Returns the location of the JavaScript file containing jQuery.
getKeyValueTable() - Method in class com.xmlmind.util.LinearHashtable
Returns the Object table used to implement this kind of hashtables.
getLayout() - Method in class com.xmlmind.whc.Compiler
Returns the selected selected for the generated Web Help.
getLocale(String) - Static method in class com.xmlmind.util.LocaleUtil
Returns the Locale corresponding to specified language.
getLog(String) - Static method in class com.xmlmind.util.Log
Returns the log having specified name.
getLong(String, long, long, long) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getLong(String, long) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getNames() - Static method in class com.xmlmind.util.Log
Returns the names of all logs returned by Log.getLog(java.lang.String).
getPaper(String, Paper) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getParent(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the parent of specified URL, if any.
getPath(URL) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.getRawPath(java.net.URL) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getPrefix() - Method in class com.xmlmind.util.SimpleConsole
Returns the prefix to be added to the messages displayed by this console; may return null.
getProperties() - Method in class com.xmlmind.util.PropertySet
Returns an Iterator of the properties contained in this property set.
getProperty(Object) - Method in class com.xmlmind.util.PropertySet
Returns the value of specified property.
getPropertyCount() - Method in class com.xmlmind.util.PropertySet
Returns the number of properties contained in this property set.
getRawBaseName(String) - Static method in class com.xmlmind.util.URIComponent
Returns the base name of specified path.
getRawBaseName(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the raw (that is, possibly containing %HH escapes) basename part of the path, if specified URL has a path.
getRawExtension(String) - Static method in class com.xmlmind.util.URIComponent
Returns the extension of specified path.
getRawExtension(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the raw (that is, possibly containing %HH escapes) extension of the path, if specified URL has a path.
getRawFragment(String) - Static method in class com.xmlmind.util.URIComponent
Returns the fragment component (not including the '#' delimiter) of specified location if any; null otherwise.
getRawParentPath(String) - Static method in class com.xmlmind.util.URIComponent
getRawParentPath(String, boolean) - Static method in class com.xmlmind.util.URIComponent
Returns the parent of specified path.
getRawPath(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the raw (that is, possibly containing %HH escapes) path, if specified URL has a path.
getRawQuery(String) - Static method in class com.xmlmind.util.URIComponent
Returns the query component (not including the '?' delimiter) of specified location if any; null otherwise.
getRawRelativePath(String, String) - Static method in class com.xmlmind.util.URIComponent
Returns first path as a path relative to the second path.
getRawRelativePath(URL, URL) - Static method in class com.xmlmind.util.URLUtil
Returns the path of specified URL relative to specified base URL.
getRawUserName(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the raw (that is, possibly containing %HH escapes) user name, if a user info is found in specified URL.
getRawUserPassword(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the raw (that is, possibly containing %HH escapes) user password, if a user info is found in specified URL.
getRecorderFactory() - Static method in class com.xmlmind.util.Log
Returns currently used RecorderFactory.
getRectangle(String, Rectangle) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getRelativePath(File, File) - Static method in class com.xmlmind.util.FileUtil
Returns the path of specified file relative to specified base.
getResolvedEntity(String, String) - Method in interface com.xmlmind.util.XMLResolver
Resolves specified the public identifier/system identifier of an entity.
getResponsiveUI() - Method in class com.xmlmind.whc.Compiler
Returns true if the UI of the generated Web Help is to be "responsive"; false otherwise.
getRoot(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the root of specified URL.
getServiceProviders(URL) - Static method in class com.xmlmind.util.JarUtil
Returns the service providers found in a JAR.
getString(String, String) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getStrings(String, String[]) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getTemplateManifestURL() - Static method in class com.xmlmind.whc.Compiler
Returns the location of whc_template/manifest.txt, May return null.
getThemeProperties() - Method in class com.xmlmind.whc.Compiler
Returns a map containing the CSS theme properties specified using Compiler.setThemeProperty(java.lang.String, java.lang.String).
getUILanguage() - Method in class com.xmlmind.whc.Compiler
Returns the language to be used for the messages of the generated Web Help.
getURL(String, URL) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getURLEntry(String, URL, URL) - Method in class com.xmlmind.util.Preferences
Considers that the specified preference contains a map which maps an URL to another URL; returns the value corresponding to specified key.
getURLs(String, URL[]) - Method in class com.xmlmind.util.Preferences
Returns specified preference.
getUserCSS() - Method in class com.xmlmind.whc.Compiler
Returns the user's CSS stylesheet to be added to an XHTML page decorated by the compiler.
getUserFooter() - Method in class com.xmlmind.whc.Compiler
Returns the user's footer to be added to an XHTML page decorated by the compiler.
getUserHeader() - Method in class com.xmlmind.whc.Compiler
Returns the user's header to be added to an XHTML page decorated by the compiler.
getUserName(URL) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.getRawUserName(java.net.URL) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getUserPassword(URL) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.getRawUserPassword(java.net.URL) except that the returned value is decoded using URIComponent.decode(java.lang.String).
getUserPreferences() - Static method in class com.xmlmind.util.Preferences
Returns the Preferences object containing application-wide user preferences.
getUserResources() - Method in class com.xmlmind.whc.Compiler
Returns the user's resource directory which is recursively copied to output_directiry/_wh/user/.
getUseStemming() - Method in class com.xmlmind.whc.Compiler
Returns true if stemming is to be used to implement the search by contents facility; otherwise returns false.
getVolume(File) - Static method in class com.xmlmind.util.FileUtil
Returns the volume of specified file.
getZipOutputStream() - Method in class com.xmlmind.util.Zip.Archive
Returns the underlying destination zip stream.
glob(String) - Static method in class com.xmlmind.util.GlobFilter
Convenience method: List all the files matching specified glob pattern.
glob(File) - Static method in class com.xmlmind.util.GlobFilter
Utility used by the GlobFilter.glob(String) convenience method: List all the files matching specified glob pattern.
GlobFilter - Class in com.xmlmind.util
An implementation of java.io.FilenameFilter which accepts file names matching a given glob pattern (as used by Unix shells).
GlobFilter(String) - Constructor for class com.xmlmind.util.GlobFilter
Constructs filter using specified glob pattern.
globMatcher - Variable in class com.xmlmind.util.GlobFilter
The underlying matcher.
GlobMatcher - Class in com.xmlmind.util
Matches a glob pattern (as used by Unix shells) against an input string.
GlobMatcher(String) - Constructor for class com.xmlmind.util.GlobMatcher
Constructs a glob pattern matcher.
globPattern - Variable in class com.xmlmind.util.GlobFilter
The string representation of the glob pattern.
globPattern - Variable in class com.xmlmind.util.GlobMatcher
The string representation of the glob pattern.
guessEncoding(byte[], int, int) - Static method in class com.xmlmind.util.LoadText
Guess the encoding of a text file by examining its first few bytes.

H

hashCode() - Method in class com.xmlmind.util.GlobMatcher
 
hashCode() - Method in class com.xmlmind.util.VersionNumber
 
hasJavaFX() - Static method in class com.xmlmind.util.SystemUtil
Returns true if the current Java runtime has a usable, found by default in the CLASSPATH, JavaFX runtime.
hasProperty(Object) - Method in class com.xmlmind.util.PropertySet
Tests if this property set contains specified property.
homeDir() - Static method in class com.xmlmind.util.SystemUtil
Returns the absolute, canonical directory corresponding to system property user.home (that is, the home directory of the user of this application) if this directory exists.
HTML_CHARSET_DETECTOR - Static variable in class com.xmlmind.util.LoadText
A ready-to-use instance of LoadText.HTMLCharsetDetector.
HTML_NO_END_TAG - Static variable in class com.xmlmind.util.XMLUtil
The set of local names of HTML (any version) elements for which the end tag must be omitted.
HTMLCharsetDetector() - Constructor for class com.xmlmind.util.LoadText.HTMLCharsetDetector
 

I

IdentityLinearHashtable<K,V> - Class in com.xmlmind.util
Identical to LinearHashtable except that keys are hashed using System.identityHashCode(java.lang.Object) and compared using ==.
IdentityLinearHashtable() - Constructor for class com.xmlmind.util.IdentityLinearHashtable
 
IdentityLinearHashtable(int) - Constructor for class com.xmlmind.util.IdentityLinearHashtable
 
indexOf(T[], T) - Static method in class com.xmlmind.util.ArrayUtil
Searches specified array for specified item.
indexOf(CharSequence, String) - Static method in class com.xmlmind.util.CharSequenceUtil
 
indexOf(CharSequence, String, int) - Static method in class com.xmlmind.util.CharSequenceUtil
 
indexOf(CharSequence, String, int, boolean) - Static method in class com.xmlmind.util.CharSequenceUtil
 
indexOf(String[], String) - Static method in class com.xmlmind.util.StringList
Searches String string within list strings.
indexOfDot(String, char) - Static method in class com.xmlmind.util.FileUtil
Returns the extension of specified path.
info(String) - Method in class com.xmlmind.util.Log
Logs specified message at level Log.Level.INFO.
inheritFontAndColors(boolean) - Method in class com.xmlmind.whc.Compiler
A shorthand invoking Compiler.setThemeProperty(java.lang.String, java.lang.String) to set all the CSS theme properties specifying the font and colors of the navigation pane to "inherit".
InputStream(InputStream) - Constructor for class com.xmlmind.util.Base64.InputStream
 
InputStream(InputStream, int) - Constructor for class com.xmlmind.util.Base64.InputStream
 
insert(T[], int, T) - Static method in class com.xmlmind.util.ArrayUtil
insert(T[], int, T[]) - Static method in class com.xmlmind.util.ArrayUtil
Inserts specified items in specified array at specified index.
insertAt(String[], String, int) - Static method in class com.xmlmind.util.StringList
Inserts a String inside a list of Strings.
INSTANCE - Static variable in class com.xmlmind.util.SimpleConsole
A ready-to-use instance of SimpleConsole
INSTANCE - Static variable in class com.xmlmind.whc.EntityResolverImpl
 
instanceString(Object) - Static method in class com.xmlmind.util.ObjectUtil
Returns a string representing specified object.
IS_GENERIC_UNIX - Static variable in class com.xmlmind.util.SystemUtil
IS_MAC_OS - Static variable in class com.xmlmind.util.SystemUtil
IS_UNIX - Static variable in class com.xmlmind.util.SystemUtil
IS_WINDOWS - Static variable in class com.xmlmind.util.SystemUtil
isAncestorOf(URL, URL) - Static method in class com.xmlmind.util.URLUtil
Tests whether first specified URL is an ancestor of second specified URL.
isDataURL(URL) - Static method in class com.xmlmind.util.URLUtil
Returns true if specified URL is a data: URL, otherwise returns false
isEmpty() - Method in class com.xmlmind.util.LinearHashtable
 
isEmptyDir(File) - Static method in class com.xmlmind.util.FileUtil
Returns true if specified file exists, is a directory and is empty.
isFileURL(URL) - Static method in class com.xmlmind.util.URLUtil
Returns true if specified URL is a file: URL, otherwise returns false
isGzipped(byte[]) - Static method in class com.xmlmind.util.FileUtil
Tests if specified data has been compressed using gzip.
isJarURL(URL) - Static method in class com.xmlmind.util.URLUtil
Returns true if specified URL is a jar: URL, otherwise returns false
isLocalJQuery() - Method in class com.xmlmind.whc.Compiler
Returns true if the jQuery files must be copied to the local resource directory created by this compiler; false otherwise.
isName(String) - Static method in class com.xmlmind.util.XMLText
Tests if specified string is a lexically correct Name.
isNameChar(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character can used in an Name at a position other the first one.
isNameOtherChar(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character, even if not authorized as the first character of an Name, can be one of the other characters of an Name.
isNameStartChar(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character can used as the start of an Name.
isNCName(String) - Static method in class com.xmlmind.util.XMLText
Tests if specified string is a lexically correct NCName.
isNCNameChar(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character can used in an NCName at a position other the first one.
isNCNameOtherChar(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character, even if not authorized as the first character of an NCName, can be one of the other characters of an NCName.
isNCNameStartChar(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character can used as the start of an NCName.
isNmtoken(String) - Static method in class com.xmlmind.util.XMLText
Tests if specified string is a lexically correct NMTOKEN.
isPITarget(String) - Static method in class com.xmlmind.util.XMLText
Tests if specified string is a lexically correct target for a process instruction.
isShowingMessageType() - Method in class com.xmlmind.util.SimpleConsole
Returns true if the type of the message should be used to prefix the messages displayed by this console; false otherwise.
isVerbose() - Method in class com.xmlmind.whc.Compiler
Returns the verbosity of this compiler.
isXMLChar(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character is a character which can be contained in a XML document.
isXMLSpace(char) - Static method in class com.xmlmind.util.XMLText
Tests if specified character is a XML space ('\t', '\r', '\n', ' ').
isXMLSpace(CharSequence) - Static method in class com.xmlmind.util.XMLText
Tests whether specified character sequence only contains XML space ('\t', '\r', '\n', ' ').
Item(Log.Level, String) - Constructor for class com.xmlmind.util.Log.Item
Constructs a buffered item containing specified message.

J

JarUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on JARs.
JAVA_9_0_0 - Static variable in class com.xmlmind.util.SystemUtil
Java v9.0.0.
javaVersionNumber() - Static method in class com.xmlmind.util.SystemUtil
Returns the version number of current JavaTM runtime.
join(char, String...) - Static method in class com.xmlmind.util.StringUtil
join(String, String...) - Static method in class com.xmlmind.util.StringUtil
Joins the items of the specified list of Strings using specified separator.
joinArguments(String...) - Static method in class com.xmlmind.util.StringUtil
joinQuotedComponents(String, String, String, String, int, String, String, String) - Static method in class com.xmlmind.util.URIComponent
Joins specified URI components, without attempting to quote them.

K

key - Variable in class com.xmlmind.util.KeyValuePair
The hashed key.
keys() - Method in class com.xmlmind.util.LinearHashtable
 
KeyValuePair<K,V> - Class in com.xmlmind.util
A key/value pair returned by some of the iterators of LinearHashtable.
KeyValuePair() - Constructor for class com.xmlmind.util.KeyValuePair
 
KeyValuePair(K, V) - Constructor for class com.xmlmind.util.KeyValuePair
 
keyword - Variable in class com.xmlmind.util.LoadText.KeywordBasedDetector
 
KeywordBasedDetector(String) - Constructor for class com.xmlmind.util.LoadText.KeywordBasedDetector
 
kill() - Method in class com.xmlmind.util.StoppableThread
Replaces deprecated, marked for removal, method Thread.stop().

L

lastIndexOf(CharSequence, String) - Static method in class com.xmlmind.util.CharSequenceUtil
 
lastIndexOf(CharSequence, String, int) - Static method in class com.xmlmind.util.CharSequenceUtil
 
lastIndexOf(CharSequence, String, int, boolean) - Static method in class com.xmlmind.util.CharSequenceUtil
 
lastModified(URL) - Static method in class com.xmlmind.util.URLUtil
Returns the date specified URL has been last modified.
level - Variable in class com.xmlmind.util.Log.Item
Level of the logged message.
level - Variable in class com.xmlmind.util.VersionNumber
Alpha, beta, release candidate or patch level.
levelType - Variable in class com.xmlmind.util.VersionNumber
Type of the release: alpha, beta, release candidate or patch.
LinearHashtable<K,V> - Class in com.xmlmind.util
A hashtable which is more compact and less efficient than Hashtable.
LinearHashtable() - Constructor for class com.xmlmind.util.LinearHashtable
Constructs a hashtable with an initial capacity of 3 key/value pairs.
LinearHashtable(int) - Constructor for class com.xmlmind.util.LinearHashtable
Constructs a hashtable with the specified initial capacity.
listEncodings() - Static method in class com.xmlmind.util.SystemUtil
Returns the canonical names of all the charsets supported by the Java runtime.
load(File) - Method in class com.xmlmind.util.Preferences
Merges the contents of specified Java properties file to this Preferences object.
load(URL) - Method in class com.xmlmind.util.Preferences
Merges the contents of specified Java properties file to this Preferences object.
load(URL, Properties) - Static method in class com.xmlmind.util.Preferences
Helper method: adds to specified properties the contents of specified URL.
loadBytes(File) - Static method in class com.xmlmind.util.FileUtil
Loads the content of a binary file.
loadBytes(InputStream) - Static method in class com.xmlmind.util.FileUtil
Loads the content of an InputStream returning binary data.
loadBytes(URL) - Static method in class com.xmlmind.util.URLUtil
Equivalent to loadBytes(url, -1).
loadBytes(URL, int) - Static method in class com.xmlmind.util.URLUtil
Loads the content of an URL containing binary data.
loadChars(Reader) - Static method in class com.xmlmind.util.LoadText
Load the characters contained in specified source.
loadString(File) - Static method in class com.xmlmind.util.FileUtil
Loads the content of a text file.
loadString(File, String) - Static method in class com.xmlmind.util.FileUtil
Loads the content of a text file.
loadString(InputStream, String) - Static method in class com.xmlmind.util.FileUtil
Loads text using specified stream.
loadString(Reader) - Static method in class com.xmlmind.util.FileUtil
Loads text using specified reader.
loadString(URL) - Static method in class com.xmlmind.util.URLUtil
loadString(URL, String) - Static method in class com.xmlmind.util.URLUtil
loadString(URL, String, int) - Static method in class com.xmlmind.util.URLUtil
Loads the content of an URL containing text.
LoadText - Class in com.xmlmind.util
A utility class allowing to load a text file.
loadText(File, String, String[], LoadText.EncodingDetector...) - Static method in class com.xmlmind.util.LoadText
loadText(URL, String, String[], LoadText.EncodingDetector...) - Static method in class com.xmlmind.util.LoadText
Loads the contents of specified text file.
loadText(InputStream, String, String[], LoadText.EncodingDetector...) - Static method in class com.xmlmind.util.LoadText
Loads the contents of specified text source.
LoadText.EmacsStyleDetector - Class in com.xmlmind.util
Detects an encoding by parsing -*- coding: ENCODING -*-.
LoadText.Encoding - Enum in com.xmlmind.util
LoadText.EncodingDetector - Interface in com.xmlmind.util
Detects an encoding by parsing an ASCII encoding specification (example: @charset "UTF-8";).
LoadText.EncodingDetectorBase - Class in com.xmlmind.util
A base class which checks for validity the encoding returned by LoadText.EncodingDetectorBase.doDetectEncoding(java.lang.String).
LoadText.HTMLCharsetDetector - Class in com.xmlmind.util
Detects an encoding by parsing <meta charset="ENCODING" > or <meta http-equiv="Content-Type" content="text/html; charset=ENCODING">.
LoadText.KeywordBasedDetector - Class in com.xmlmind.util
Detects an encoding by parsing KEYWORD "ENCODING";, for example @charset "ENCODING";.
LoadText.XMLEncodingDetector - Class in com.xmlmind.util
Detects an encoding by parsing <?xml encoding="ENCODING"?>.
LocaleUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on Locales.
Localizer - Class in com.xmlmind.util
Helper class used to create localized, formatted, messages.
Localizer(Class<?>) - Constructor for class com.xmlmind.util.Localizer
Constructs a Localizer which uses java.text.MessageFormats found in package_name.Messages_locale.properties java.util.ResourceBundles to create its localized, formatted, messages.
Log - Class in com.xmlmind.util
A simple log facility which implements the following services: Log messages to a cyclic in-memory buffer.
log(Log.Level, String) - Method in class com.xmlmind.util.Log
Logs specified message at specified level.
Log.Item - Class in com.xmlmind.util
A buffered item.
Log.Level - Enum in com.xmlmind.util
Log levels.
Log.Recorder - Interface in com.xmlmind.util
Underlying logger.
Log.RecorderFactory - Interface in com.xmlmind.util
Underlying logger factory.
Log.RecorderFactoryImpl - Class in com.xmlmind.util
Creates and returns Log.RecorderImpls.
Log.RecorderImpl - Class in com.xmlmind.util
A message recorder that does not nothing at.

M

main(String[]) - Static method in class com.xmlmind.whc.Compiler
 
major - Variable in class com.xmlmind.util.VersionNumber
Major version number.
mark(int) - Method in class com.xmlmind.util.Base64.InputStream
 
markSupported() - Method in class com.xmlmind.util.Base64.InputStream
 
matcher - Variable in class com.xmlmind.util.GlobMatcher
The underlying java.util.regex.Matcher.
matches(String) - Method in class com.xmlmind.util.GlobMatcher
Matches this glob pattern against specified string.
MAX_CAPACITY - Static variable in class com.xmlmind.util.Log
Maximum buffering capacity (100,000).
message - Variable in class com.xmlmind.util.Log.Item
Logged message.
message(String, Console.MessageType) - Method in class com.xmlmind.util.NoProgressMonitor
 
message(String, Console.MessageType) - Method in interface com.xmlmind.util.ProgressMonitor
Invoked by the lengthy task to give this monitor information about the step being executed.
message(String, Console.MessageType) - Method in class com.xmlmind.util.SimpleProgressMonitor
 
messageLevel - Variable in class com.xmlmind.util.SimpleProgressMonitor
All messages having a type larger than messageLevel are not printed by this monitor.
micro - Variable in class com.xmlmind.util.VersionNumber
Micro version number.
MIN_VERSION_NUMBER - Static variable in class com.xmlmind.util.VersionNumber
Minimal version number: 0.0.0-alpha00.
minor - Variable in class com.xmlmind.util.VersionNumber
Minor version number.
monitor - Variable in class com.xmlmind.util.ProgressMonitorConsole
The ProgressMonitor to which messages are forwarded.
msg(String) - Method in class com.xmlmind.util.Localizer
Returns localized message having specified ID.
msg(String, Object...) - Method in class com.xmlmind.util.Localizer
Returns localized message having specified ID and formatted using specified arguments.

N

newPaper(double, double, double, double, double, double) - Static method in class com.xmlmind.util.Preferences
Helper function: returns a new Paper initialized using specified paper size and specified imageable area.
newSAXParser() - Static method in class com.xmlmind.util.XMLUtil
newSAXParser(boolean, boolean, boolean) - Static method in class com.xmlmind.util.XMLUtil
Convenience method: creates and returns a SAXParser.
newURL(String) - Static method in class com.xmlmind.util.URLUtil
A cover for URL.URL(String).
newURL(URL, String) - Static method in class com.xmlmind.util.URLUtil
newURL(URL, String, URLStreamHandler) - Static method in class com.xmlmind.util.URLUtil
newURL(String, String, String) - Static method in class com.xmlmind.util.URLUtil
newURL(String, String, int, String) - Static method in class com.xmlmind.util.URLUtil
newURL(String, String, int, String, URLStreamHandler) - Static method in class com.xmlmind.util.URLUtil
NO_OBJECTS - Static variable in class com.xmlmind.util.ObjectUtil
An empty array of Objects.
noLevel() - Method in class com.xmlmind.util.VersionNumber
Returns a copy of this VersionNumber but with all level info (alpha, beta, release candidate, patch) cleared.
NoProgressMonitor - Class in com.xmlmind.util
A ProgressMonitor which does not report progress.
NoProgressMonitor() - Constructor for class com.xmlmind.util.NoProgressMonitor
 
normalizeContentType(String, String) - Static method in class com.xmlmind.util.URLUtil
Returns a normalized string form for specified content type.
normalizeLang(String) - Static method in class com.xmlmind.util.LocaleUtil
normalizeLang(String, String[]) - Static method in class com.xmlmind.util.LocaleUtil
Returns a normalized, possibly simplified, version of specified language.

O

ObjectUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on Objects.
openConnectionNoCache(URL) - Static method in class com.xmlmind.util.URLUtil
Similar to url.openConnection except that the accessed resource may not be a cached copy.
openConnectionUseCache(URL) - Static method in class com.xmlmind.util.URLUtil
Similar to url.openConnection except that the accessed resource may be a cached copy.
openStreamNoCache(URL) - Static method in class com.xmlmind.util.URLUtil
Similar to url.openStream except that the accessed resource may not be a cached copy.
openStreamUseCache(URL) - Static method in class com.xmlmind.util.URLUtil
Similar to url.openStream except that the accessed resource may be a cached copy.
osVersionNumber() - Static method in class com.xmlmind.util.SystemUtil
Returns the version number of the operating system.
OutputStream(OutputStream) - Constructor for class com.xmlmind.util.Base64.OutputStream
 
OutputStream(OutputStream, int) - Constructor for class com.xmlmind.util.Base64.OutputStream
 

P

parse(String, VersionNumber) - Static method in class com.xmlmind.util.VersionNumber
Parses specified string and returns the result in the specified version number object.
parseParameters(String[]) - Method in class com.xmlmind.whc.Compiler
parseParameters(String[], URL) - Method in class com.xmlmind.whc.Compiler
For internal use only.
Platform - Enum in com.xmlmind.util
All the possible platforms.
PLATFORM - Static variable in class com.xmlmind.util.SystemUtil
Returns the platform running this application: Platform.WINDOWS, Platform.MAC_OS or Platform.GENERIC_UNIX.
Preferences - Class in com.xmlmind.util
Class used by an application to store the preferences of its user.
Preferences() - Constructor for class com.xmlmind.util.Preferences
Constructs an empty Preferences object.
Preferences(Properties) - Constructor for class com.xmlmind.util.Preferences
Constructs a Preferences object acting a a wrapper for specified Properties object.
prepend(T[], T) - Static method in class com.xmlmind.util.ArrayUtil
Inserts specified item in specified array at the beginning of specified array.
prepend(String[], String) - Static method in class com.xmlmind.util.StringList
Inserts a String as first item of a list of Strings.
print(boolean, PrintStream) - Method in class com.xmlmind.util.Log.Item
Prints this item to specified output stream.
print(boolean, boolean, PrintStream) - Method in class com.xmlmind.util.Log
Prints all logged items to specified output stream.
ProgressMonitor - Interface in com.xmlmind.util
Interface implemented by objects wishing to monitor the execution of a lengthy task.
ProgressMonitorConsole - Class in com.xmlmind.util
A Console which forwards its message to a ProgressMonitor.
ProgressMonitorConsole(ProgressMonitor) - Constructor for class com.xmlmind.util.ProgressMonitorConsole
Constructs a console.
properties - Variable in class com.xmlmind.util.Preferences
The Properties object being wrapped by this Preferences object.
PropertySet - Class in com.xmlmind.util
Base class for objects which can have a set of properties.
put(K, V) - Method in class com.xmlmind.util.IdentityLinearHashtable
 
put(K, V) - Method in class com.xmlmind.util.LinearHashtable
 
putAll(Preferences) - Method in class com.xmlmind.util.Preferences
Adds or replaces preferences with preferences read from another Preferences object.
putBoolean(String, boolean) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putColor(String, Color) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putDouble(String, double) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putDoubles(String, double[]) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putFont(String, Font) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putInt(String, int) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putInts(String, int[]) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putLong(String, long) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putPaper(String, Paper) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference for the format of the paper used when printing documents.
putProperties(PropertySet) - Method in class com.xmlmind.util.PropertySet
Adds (or replaces) all the properties found in specified set.
putProperty(Object, Object) - Method in class com.xmlmind.util.PropertySet
Adds or replaces a property.
putRectangle(String, Rectangle) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putString(String, String) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putStrings(String, String[]) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putURL(String, URL) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.
putURLEntry(String, URL, URL, int) - Method in class com.xmlmind.util.Preferences
Considers that the specified preference contains a map which maps an URL to another URL; adds or replaces in this map the value corresponding to specified key.
putURLs(String, URL[]) - Method in class com.xmlmind.util.Preferences
Adds or replaces preference.

Q

quote(String) - Static method in class com.xmlmind.util.StringUtil
Like StringUtil.escape(java.lang.String) but puts a double quote character ('\"') around the escaped string.
quoteArgument(String) - Static method in class com.xmlmind.util.StringUtil
Quotes specified string using '\"' if needed to.
quoteFragment(String) - Static method in class com.xmlmind.util.URIComponent
Quotes specified fragment (that is, escapes ``special'' characters).
quoteFullPath(String) - Static method in class com.xmlmind.util.URIComponent
Quotes specified path (that is, escapes ``special'' characters).
quoteFullPath(String, StringBuilder) - Static method in class com.xmlmind.util.URIComponent
Similar tp URIComponent.quoteFullPath(String) but appends quoted path to specified buffer.
quotePath(String) - Static method in class com.xmlmind.util.URIComponent
Quotes specified path (that is, escapes ``special'' characters).
quoteQuery(String) - Static method in class com.xmlmind.util.URIComponent
Quotes specified query (that is, escapes ``special'' characters).
quoteUserInfo(String) - Static method in class com.xmlmind.util.URIComponent
Quotes specified user info (that is, escapes ``special'' characters).
quoteXML(String) - Static method in class com.xmlmind.util.XMLText
Escapes specified string (that is, '<' is replaced by "&#60;", '&' is replaced by "&#38;", etc) then puts the escaped string between quotes (").
quoteXML(String, StringBuilder) - Static method in class com.xmlmind.util.XMLText
Escapes specified string (that is, '<' is replaced by "&#60;", '&' is replaced by "&#38;", etc) then puts the escaped string between quotes (").

R

read() - Method in class com.xmlmind.util.Base64.InputStream
 
read(byte[]) - Method in class com.xmlmind.util.Base64.InputStream
 
read(byte[], int, int) - Method in class com.xmlmind.util.Base64.InputStream
 
reason(Throwable) - Static method in class com.xmlmind.util.ThrowableUtil
Returns the message of specified exception.
reasonLine(Throwable) - Static method in class com.xmlmind.util.ThrowableUtil
One line describing specified Throwable in a comprehensive way.
record(Log.Level, String) - Method in interface com.xmlmind.util.Log.Recorder
Records specified message.
record(Log.Level, String) - Method in class com.xmlmind.util.Log.RecorderImpl
 
recorder - Variable in class com.xmlmind.util.Log
The underlying logger used by this Log object.
RecorderFactoryImpl() - Constructor for class com.xmlmind.util.Log.RecorderFactoryImpl
 
RecorderImpl() - Constructor for class com.xmlmind.util.Log.RecorderImpl
 
RegexMatch - Class in com.xmlmind.util
Input subsequence captured by the given group during the previous match operation.
RegexMatch(int, int, String) - Constructor for class com.xmlmind.util.RegexMatch
Constructor.
remove(T[], T) - Static method in class com.xmlmind.util.ArrayUtil
Remove specified item from specified array.
remove(K) - Method in class com.xmlmind.util.IdentityLinearHashtable
 
remove(K) - Method in class com.xmlmind.util.LinearHashtable
 
remove(String) - Method in class com.xmlmind.util.Preferences
Removes specified preference.
remove(String[], String) - Static method in class com.xmlmind.util.StringList
Removes a String from a list of Strings.
removeAll() - Method in class com.xmlmind.util.Preferences
Removes all preferences.
removeAllProperties() - Method in class com.xmlmind.util.PropertySet
Removes all properties from set.
removeAt(T[], int) - Static method in class com.xmlmind.util.ArrayUtil
Equivalent to remove(list, index, 1).
removeAt(T[], int, int) - Static method in class com.xmlmind.util.ArrayUtil
Removes a range of items found at specified index from specified array.
removeAt(String[], int) - Static method in class com.xmlmind.util.StringList
Removes an item specified by its position from a list of Strings.
removeProperty(Object) - Method in class com.xmlmind.util.PropertySet
Removes a property.
replaceAll(String, String, String) - Static method in class com.xmlmind.util.StringUtil
Replaces substring oldSub by substring newSub inside String string.
replaceWhiteSpace(String) - Static method in class com.xmlmind.util.XMLText
Replaces sequence "\r\n" and characters '\t', '\r', '\n' by a single space character ' '.
requestStop() - Method in class com.xmlmind.util.StoppableThread
Request this thread to stop and interrupt it.
reset() - Method in class com.xmlmind.util.Base64.InputStream
 
resolve(String, File, boolean) - Static method in class com.xmlmind.util.GlobFilter
Utility used by the GlobFilter.glob(String) convenience method: Resolve specified path against specified base directory.
resolve(String, String) - Method in interface com.xmlmind.util.XMLResolver
 
resolveEntity(String, String) - Method in interface com.xmlmind.util.XMLResolver
 
resolveEntity(String, String) - Method in class com.xmlmind.whc.EntityResolverImpl
 
resolveURI(String) - Method in interface com.xmlmind.util.XMLResolver
Resolves specified URI.
resolveURI(String, URL) - Method in interface com.xmlmind.util.XMLResolver
Resolves specified URI.
reverse(T[]) - Static method in class com.xmlmind.util.ArrayUtil
Reverses the order of the items in the specified array.

S

sameContentType(String, String, String) - Static method in class com.xmlmind.util.URLUtil
Tests whether specified content types are identical.
sameRoot(URL, URL) - Static method in class com.xmlmind.util.URLUtil
Returns true if specified URLs have the same root.
save(File, String) - Method in class com.xmlmind.util.Preferences
Saves this Preferences object to specified Java properties file.
save(Properties, File, String) - Static method in class com.xmlmind.util.Preferences
Helper method: saves specified properties to specified file.
saveBytes(byte[], File) - Static method in class com.xmlmind.util.FileUtil
Saves binary data to a file.
SaveDocument - Class in com.xmlmind.whc
Not part of the public documented API: helper class used to save XHTML documents.
saveString(String, File) - Static method in class com.xmlmind.util.FileUtil
Saves some text to a file.
saveString(String, File, String) - Static method in class com.xmlmind.util.FileUtil
Saves some text to a file.
saveString(String, OutputStream, String) - Static method in class com.xmlmind.util.FileUtil
Saves some text to an OutputStream.
saveXHTML(Document, File) - Static method in class com.xmlmind.whc.SaveDocument
 
saveXHTML(Document, File, String) - Static method in class com.xmlmind.whc.SaveDocument
 
saveXHTML(Document, File, String, boolean) - Static method in class com.xmlmind.whc.SaveDocument
 
setCapacity(int) - Method in class com.xmlmind.util.Log
Specifies buffering capacity.
setCollapseTOC(boolean) - Method in class com.xmlmind.whc.Compiler
Specifies whether the TOC should be initially collapsed.
setDefaultLanguage(String) - Method in class com.xmlmind.whc.Compiler
Specifies the language used when the XHTML page being parsed does not specify a xml:lang or lang attribute on its html root element.
setErrorLevel(Console.MessageType) - Method in class com.xmlmind.util.SimpleConsole
Specifies the least severe message type displayed by this console.
setExtension(File, String) - Static method in class com.xmlmind.util.FileUtil
Changes the extension of specified file to specified extension.
setExtension(String, String) - Static method in class com.xmlmind.util.FileUtil
Similar to FileUtil.setExtension(File, String) except that it acts on a filename rather than on a File.
setExtension(String, String) - Static method in class com.xmlmind.util.URIComponent
setExtension(URL, String) - Static method in class com.xmlmind.util.URLUtil
setFragment(String, String) - Static method in class com.xmlmind.util.URIComponent
setFragment(URL, String) - Static method in class com.xmlmind.util.URLUtil
setIdMapHref(String) - Method in class com.xmlmind.whc.Compiler
Instructs this compiler to save an ID map to output_dir/_wh/idMap.xml.
setIdMapIdPrefix(String) - Method in class com.xmlmind.whc.Compiler
In addition to the IDs of "formal elements" (sections, figures, tables, etc) which are automatically added to the ID map, also add the IDs starting with specified prefix.
setIdMapTitle(String) - Method in class com.xmlmind.whc.Compiler
Instructs this compiler to save an ID map to output_dir/_wh/idMap.xml.
setIndexNumbers(boolean) - Method in class com.xmlmind.whc.Compiler
Specifies whether words looking like numbers are to be indexed.
setJQuery(String) - Method in class com.xmlmind.whc.Compiler
Specifies the location of the JavaScript file containing jQuery.
setLayout(String) - Method in class com.xmlmind.whc.Compiler
Selects a layout for the generated Web Help.
setLocalJQuery(boolean) - Method in class com.xmlmind.whc.Compiler
Specifies whether the jQuery files must be copied to the local resource directory created by this compiler.
setPrefix(String) - Method in class com.xmlmind.util.SimpleConsole
Specifies the prefix to be added to the messages displayed by this console; may be null.
setRawExtension(String, String) - Static method in class com.xmlmind.util.URIComponent
Changes the extension of specified path to specified extension.
setRawExtension(URL, String) - Static method in class com.xmlmind.util.URLUtil
Changes the extension of specified URL to specified extension.
setRawFragment(String, String) - Static method in class com.xmlmind.util.URIComponent
Changes the fragment component of specified location to specified fragment.
setRawFragment(URL, String) - Static method in class com.xmlmind.util.URLUtil
Changes the fragment of specified URL to specified fragment.
setRawQuery(String, String) - Static method in class com.xmlmind.util.URIComponent
Changes the query component of specified location to specified query.
setRawUserInfo(URL, String, String) - Static method in class com.xmlmind.util.URLUtil
Changes the user info of specified URL to specified user info.
setRecorderFactory(Log.RecorderFactory) - Static method in class com.xmlmind.util.Log
Specifies which RecorderFactory to use.
setResponsiveUI(boolean) - Method in class com.xmlmind.whc.Compiler
Specifies whether the UI of the generated Web Help is to be "responsive".
setShowingMessageType(boolean) - Method in class com.xmlmind.util.SimpleConsole
Specifies whether the type of the message should be used to prefix the messages displayed by this console.
setTemplateManifestURL(URL) - Static method in class com.xmlmind.whc.Compiler
Specifies the location of whc_template/manifest.txt, the manifest file listing all the files used by the compiler to ``decorate'' an XHTML page.
setThemeProperty(String, String) - Method in class com.xmlmind.whc.Compiler
Override a CSS theme property with specified values.
setUILanguage(String) - Method in class com.xmlmind.whc.Compiler
Specifies the language to be used for the messages of the generated Web Help.
setUserCSS(URL) - Method in class com.xmlmind.whc.Compiler
Specifies the user's CSS stylesheet which is to be added to an XHTML page decorated by the compiler.
setUserFooter(URL) - Method in class com.xmlmind.whc.Compiler
Specifies the user's footer which is to be added to an XHTML page decorated by the compiler.
setUserHeader(URL) - Method in class com.xmlmind.whc.Compiler
Specifies the user's header which is to be added to an XHTML page decorated by the compiler.
setUserInfo(URL, String, String) - Static method in class com.xmlmind.util.URLUtil
setUserPreferences(Preferences) - Static method in class com.xmlmind.util.Preferences
Installs the Preferences object containing application-wide user preferences.
setUserPreferencesDir(File) - Static method in class com.xmlmind.util.SystemUtil
Specify a custom user preferences directory.
setUserResources(File) - Method in class com.xmlmind.whc.Compiler
Specifies a user's resource directory which is to be recursively copied to output_directory/_wh/user/.
setUseStemming(boolean) - Method in class com.xmlmind.whc.Compiler
Specifies whether stemming should be used to implement the search by contents facility.
setVerbose(boolean) - Method in class com.xmlmind.whc.Compiler
Specifies the verbosity of this compiler.
shellExec(String, String[]) - Static method in class com.xmlmind.util.SystemUtil
shellExec(String, String[], File, String[]) - Static method in class com.xmlmind.util.SystemUtil
Executes a command using the standard shell of the platform, capturing output to System.out and System.err.
shellExec(String) - Static method in class com.xmlmind.util.SystemUtil
shellExec(String, String[], File) - Static method in class com.xmlmind.util.SystemUtil
shellExec(String, String[], File, Console) - Static method in class com.xmlmind.util.SystemUtil
Executes a command using the standard shell of the platform.
shellStart(String) - Static method in class com.xmlmind.util.SystemUtil
shellStart(String, String[], File) - Static method in class com.xmlmind.util.SystemUtil
Executes a command using the standard shell of the platform.
shortenText(String, int) - Static method in class com.xmlmind.util.StringUtil
Returns specified text after ensuring that it's shorter than specified maximum length.
showMessage(String, Console.MessageType) - Method in interface com.xmlmind.util.Console
Show specified message to user.
showMessage(String, Console.MessageType) - Method in class com.xmlmind.util.ProgressMonitorConsole
 
showMessage(String, Console.MessageType) - Method in class com.xmlmind.util.SimpleConsole
 
SimpleConsole - Class in com.xmlmind.util
An implementation of Console which prints its messages to System.err and System.out.
SimpleConsole() - Constructor for class com.xmlmind.util.SimpleConsole
SimpleConsole(String, boolean, Console.MessageType) - Constructor for class com.xmlmind.util.SimpleConsole
Constructs a SimpleConsole.
SimpleProgressMonitor - Class in com.xmlmind.util
A simple ProgressMonitor printing error and warning messages on System.err and other messages (info, verbose, debug) on System.out.
SimpleProgressMonitor() - Constructor for class com.xmlmind.util.SimpleProgressMonitor
SimpleProgressMonitor(Console.MessageType) - Constructor for class com.xmlmind.util.SimpleProgressMonitor
Constructs a simple ProgressMonitor.
size() - Method in class com.xmlmind.util.LinearHashtable
Returns the number of key/value pairs currently stored in this hashtable.
skip(long) - Method in class com.xmlmind.util.Base64.InputStream
 
split(String) - Static method in class com.xmlmind.util.StringUtil
Splits specified string at whitespace character boundaries.
split(String, char) - Static method in class com.xmlmind.util.StringUtil
Splits String string at occurrences of char separatorChar.
splitArguments(String) - Static method in class com.xmlmind.util.StringUtil
Splits specified string in a manner which is similar to what is done for command line arguments.
splitList(String) - Static method in class com.xmlmind.util.XMLText
Splits specified string at XML whitespace character boundaries ('\t', '\r', '\n', ' ').
start() - Method in class com.xmlmind.util.NoProgressMonitor
 
start() - Method in interface com.xmlmind.util.ProgressMonitor
Invoked by the lengthy task to inform this monitor that the execution of the task has started.
start() - Method in class com.xmlmind.util.SimpleProgressMonitor
 
start() - Method in class com.xmlmind.util.StoppableThread
 
startIndex - Variable in class com.xmlmind.util.RegexMatch
Index of the start of the input subsequence.
step(int) - Method in class com.xmlmind.util.NoProgressMonitor
 
step(int) - Method in interface com.xmlmind.util.ProgressMonitor
Invoked by the lengthy task to inform this monitor each time a new step is about to be executed.
step(int) - Method in class com.xmlmind.util.SimpleProgressMonitor
 
stepCount(int) - Method in class com.xmlmind.util.NoProgressMonitor
 
stepCount(int) - Method in interface com.xmlmind.util.ProgressMonitor
Invoked by the lengthy task to inform this monitor about the total numbers of steps comprising the task.
stepCount(int) - Method in class com.xmlmind.util.SimpleProgressMonitor
 
stop() - Method in class com.xmlmind.util.NoProgressMonitor
 
stop() - Method in interface com.xmlmind.util.ProgressMonitor
Invoked by the lengthy task to inform this monitor that the execution of the task has stopped, whatever the reason (success, canceled, error).
stop() - Method in class com.xmlmind.util.SimpleProgressMonitor
 
stopIsRequested() - Static method in class com.xmlmind.util.StoppableThread
Tests wether StoppableThread.requestStop() has already been invoked for Thread.currentThread().
StoppableThread - Class in com.xmlmind.util
A Thread in which deprecated, marked for removal, method Thread.stop() has been "replaced" by StoppableThread.requestStop(), StoppableThread.stopRequested() and StoppableThread.kill().
StoppableThread() - Constructor for class com.xmlmind.util.StoppableThread
 
StoppableThread(Runnable) - Constructor for class com.xmlmind.util.StoppableThread
 
StoppableThread(String) - Constructor for class com.xmlmind.util.StoppableThread
 
StoppableThread(Runnable, String) - Constructor for class com.xmlmind.util.StoppableThread
 
StoppableThread(ThreadGroup, Runnable) - Constructor for class com.xmlmind.util.StoppableThread
 
StoppableThread(ThreadGroup, String) - Constructor for class com.xmlmind.util.StoppableThread
 
StoppableThread(ThreadGroup, Runnable, String) - Constructor for class com.xmlmind.util.StoppableThread
 
StoppableThread(ThreadGroup, Runnable, String, long) - Constructor for class com.xmlmind.util.StoppableThread
 
stopRequested() - Method in class com.xmlmind.util.StoppableThread
Tests wether StoppableThread.requestStop() has already been invoked.
StringList - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on lists of Strings.
StringUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on Strings.
subArray(T[], int) - Static method in class com.xmlmind.util.ArrayUtil
subArray(T[], int, int) - Static method in class com.xmlmind.util.ArrayUtil
Returns a sub-array of specified array.
substituteVars(String, char[], Object[]) - Static method in class com.xmlmind.util.StringUtil
substituteVars(String, char[], Object[], String[], String) - Static method in class com.xmlmind.util.StringUtil
substituteVars(String, char[], Object[], String[], String, boolean) - Static method in class com.xmlmind.util.StringUtil
Returns specified text where %0, %1, ..., %9, %* and %X, %Y, etc, variables have been subsituted by specified values.
substring(CharSequence, int) - Static method in class com.xmlmind.util.CharSequenceUtil
 
substring(CharSequence, int, int) - Static method in class com.xmlmind.util.CharSequenceUtil
 
SystemUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) which complements what's found in java.lang.System.

T

text - Variable in class com.xmlmind.util.RegexMatch
Text contained in the input subsequence.
ThrowableUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) related to Exceptions.
toDisplayForm(URL) - Static method in class com.xmlmind.util.URLUtil
Same as java.net.URL.toExternalForm except that returned string may contain non-ASCII characters and that, if specified URL contains a password, the characters of this password are replaced by '*'.
toLabel(URL) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.toDisplayForm(java.net.URL) but file: URLs not having a fragment are displayed as plain file names.
toShortDisplayForm(URL, int) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.toDisplayForm(java.net.URL) except that the returned string is made shorter than specified length (when possible).
toShortLabel(URL, int) - Static method in class com.xmlmind.util.URLUtil
Same as URLUtil.toLabel(java.net.URL) except that the returned string is made shorter than specified length (when possible).
toString() - Method in class com.xmlmind.util.GlobMatcher
 
toString() - Method in class com.xmlmind.util.LinearHashtable
Returns a string representation of this hashtable which may be used during debugging.
toString() - Method in class com.xmlmind.util.Log.Item
 
toString() - Method in class com.xmlmind.util.RegexMatch
toString() - Method in enum com.xmlmind.util.VersionNumber.LevelType
 
toString() - Method in class com.xmlmind.util.VersionNumber
Returns a string having the following format: major.minor.micro if this version number is not an alpha, beta, Release candidate or patch release.
trimToSize(T[], int) - Static method in class com.xmlmind.util.ArrayUtil
Returns specified array if its length is equal to specified size; otherwise returns a copy of specified array having specified size.
truncatePath(String, int) - Static method in class com.xmlmind.util.URIComponent
Truncates specified path to get something short enough to be displayed in the "Recently Opened Files" part of a File menu.

U

uncapitalize(String) - Static method in class com.xmlmind.util.StringUtil
Returns the specified string with its first character converted to lower case.
unescape(String) - Static method in class com.xmlmind.util.StringUtil
Returns the specified string with Java escape sequences (that is '\n', 'é', etc) replaced by the corresponding character.
unescapeXML(String) - Static method in class com.xmlmind.util.XMLText
Unescapes specified string.
unescapeXML(String, int, int, StringBuilder) - Static method in class com.xmlmind.util.XMLText
Unescapes specified string.
unquote(String) - Static method in class com.xmlmind.util.StringUtil
Like StringUtil.unescape(java.lang.String) but removes the double quote characters ('\"'), if any, before unescaping the string.
unzip(File, File) - Static method in class com.xmlmind.util.Zip
Extracts files contained in specified stream to specified directory.
unzip(ZipInputStream, File) - Static method in class com.xmlmind.util.Zip
Extracts file contained in specified stream to specified directory.
URIComponent - Class in com.xmlmind.util
A collection of low-level utility functions (static methods) related to URI components (Strings, not java.net.URI).
URLComparator() - Constructor for class com.xmlmind.util.URLUtil.URLComparator
 
urlOrFile(String) - Static method in class com.xmlmind.util.URLUtil
urlOrFile(String, boolean) - Static method in class com.xmlmind.util.URLUtil
urlOrFile(String, boolean, boolean) - Static method in class com.xmlmind.util.URLUtil
urlOrFile(String, boolean, boolean, URL) - Static method in class com.xmlmind.util.URLUtil
Returns an URL created from specified path.
urlToFile(URL) - Static method in class com.xmlmind.util.URLUtil
Converts a file: URL to a File.
urlToURI(URL) - Static method in class com.xmlmind.util.URLUtil
Similar to java.net.URL.toURI() except that this utility will not throw a java.net.URISyntaxException if the URL spec contains illegal characters such as spaces.
URLUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) operating on URLs.
URLUtil.URLComparator - Class in com.xmlmind.util
Compares two URLs by their external forms.
userPreferencesDir() - Static method in class com.xmlmind.util.SystemUtil
Returns the user preferences directory of this application.
userPreferencesDir(String, String, String) - Static method in class com.xmlmind.util.SystemUtil
Returns the directory used to store the preferences of specified application.

V

value - Variable in class com.xmlmind.util.KeyValuePair
The value associated to the above key.
valueOf(String) - Static method in enum com.xmlmind.util.Console.MessageType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xmlmind.util.LoadText.Encoding
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xmlmind.util.Log.Level
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xmlmind.util.Platform
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xmlmind.util.VersionNumber.LevelType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.xmlmind.util.Console.MessageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xmlmind.util.LoadText.Encoding
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xmlmind.util.Log.Level
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xmlmind.util.Platform
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xmlmind.util.VersionNumber.LevelType
Returns an array containing the constants of this enum type, in the order they are declared.
verbose(String) - Method in class com.xmlmind.util.Log
Logs specified message at level Log.Level.VERBOSE.
VERSION - Static variable in class com.xmlmind.whc.Compiler
The version number of this Compiler.
VersionNumber - Class in com.xmlmind.util
Structured version numbers similar to those used for the JavaTM runtime (example: 1.5.0_06).
VersionNumber() - Constructor for class com.xmlmind.util.VersionNumber
Constructs a minimal version number: 0.0.0-alpha00.
VersionNumber(int, int, int) - Constructor for class com.xmlmind.util.VersionNumber
Constructs version number major.minor.micro.
VersionNumber(int, int, int, int) - Constructor for class com.xmlmind.util.VersionNumber
Constructs version number major.minor.micro_patch.
VersionNumber(int, int, int, VersionNumber.LevelType, int) - Constructor for class com.xmlmind.util.VersionNumber
Constructs version number major.minor.micro (-alpha|-beta|-rc|_)level.
VersionNumber.LevelType - Enum in com.xmlmind.util
Type of the release: alpha, beta, release candidate or patch.

W

warning(String) - Method in class com.xmlmind.util.Log
Logs specified message at level Log.Level.WARNING.
wordWrap(String, int) - Static method in class com.xmlmind.util.StringUtil
Splits specified string at word boundaries, returning an array of lines having at most specified number of characters.
write(int) - Method in class com.xmlmind.util.Base64.OutputStream
 
write(byte[]) - Method in class com.xmlmind.util.Base64.OutputStream
 
write(byte[], int, int) - Method in class com.xmlmind.util.Base64.OutputStream
 

X

xhtmlToString(Node) - Static method in class com.xmlmind.whc.SaveDocument
 
xhtmlToString(Node, boolean) - Static method in class com.xmlmind.whc.SaveDocument
 
XML_ENCODING_DETECTOR - Static variable in class com.xmlmind.util.LoadText
A ready-to-use instance of LoadText.XMLEncodingDetector.
XMLEncodingDetector() - Constructor for class com.xmlmind.util.LoadText.XMLEncodingDetector
 
XMLResolver - Interface in com.xmlmind.util
Specifies the catalog-based entity resolution services needed by most XMLmind software components.
XMLText - Class in com.xmlmind.util
A collection of utility functions (static methods) related to XML characters and XML text.
XMLUtil - Class in com.xmlmind.util
A collection of utility functions (static methods) related to XML.

Z

Zip - Class in com.xmlmind.util
Utility class which makes it easier zipping and unzipping files.
zip(File, boolean, FilenameFilter, File) - Static method in class com.xmlmind.util.Zip
Creates a zip archive containing the content of specified directory.
Zip.Archive - Class in com.xmlmind.util
This class allows a fine-grained control on the files to be added to the zip archive.
A B C D E F G H I J K L M N O P Q R S T U V W X Z 
Skip navigation links