- 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
-
- captureOutput(Process, Console) - Static method in class com.xmlmind.util.SystemUtil
-
- 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, boolean) - Static method in class com.xmlmind.util.URLUtil
-
Establish specified HTTP connection and check whether it returns
a "200 OK".
- checkId(String) - Static method in class com.xmlmind.util.XMLText
-
- 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
-
- 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
-
- 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
-
- 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.
- elements() - Method in class com.xmlmind.util.LinearHashtable
-
- EMACS_STYLE_DETECTOR - Static variable in class com.xmlmind.util.LoadText
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- escapeXML(String) - Static method in class com.xmlmind.util.XMLText
-
Escapes specified string (that is,
'<' is replaced by "<",
'&' is replaced by "&", etc).
- escapeXML(String, StringBuilder) - Static method in class com.xmlmind.util.XMLText
-
Escapes specified string (that is,
'<' is replaced by "<",
'&' is replaced by "&", etc).
- escapeXML(char[], int, int, StringBuilder) - Static method in class com.xmlmind.util.XMLText
-
Escapes specified character array
(that is, '<' is replaced
by "<", '&' is replaced
by "&", etc).
- escapeXML(char[], int, int, StringBuilder, int) - Static method in class com.xmlmind.util.XMLText
-
Escapes specified character array (that is, '<' is replaced
by "<", '&' is replaced by
"&", etc).
- exists(URL) - Static method in class com.xmlmind.util.URLUtil
-
- exists(URL, boolean, int) - Static method in class com.xmlmind.util.URLUtil
-
Tests whether specified URL corresponds to an existing resource.
- 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
-
- getBaseName(URL) - Static method in class com.xmlmind.util.URLUtil
-
- 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
-
- getExtension(String) - Static method in class com.xmlmind.util.URIComponent
-
- getExtension(URL) - Static method in class com.xmlmind.util.URLUtil
-
- getFavicon() - Method in class com.xmlmind.whc.Compiler
-
Returns the favicon to be added to an XHTML page decorated
by the compiler.
- getFont(String, Font) - Method in class com.xmlmind.util.Preferences
-
Returns specified preference.
- getFragment(String) - Static method in class com.xmlmind.util.URIComponent
-
- getFragment(URL) - Static method in class com.xmlmind.util.URLUtil
-
- getIdMapHref() - Method in class com.xmlmind.whc.Compiler
-
- getIdMapIdPrefix() - Method in class com.xmlmind.whc.Compiler
-
- getIdMapTitle() - Method in class com.xmlmind.whc.Compiler
-
- 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
-
- 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
-
- 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
-
- 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
-
- getUserPassword(URL) - Static method in class com.xmlmind.util.URLUtil
-
- 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.
- IdentityLinearHashtable<K,V> - Class in com.xmlmind.util
-
- 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
-
- inheritFontAndColors(boolean) - Method in class com.xmlmind.whc.Compiler
-
- 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.
- 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
-
- lastModified(URL, boolean, int) - Static method in class com.xmlmind.util.URLUtil
-
Returns the date of the resource having specified URL.
- 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
-
- loadBytes(URL, boolean, 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, boolean, 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
-
- loadText(URL, boolean, int, 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
-
- 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.MessageFormat
s
found in package_name.Messages_locale.properties
java.util.ResourceBundle
s 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
-
- Log.RecorderImpl - Class in com.xmlmind.util
-
A message recorder that does not nothing at.
- 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
-
- 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
-
- 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.
- 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
-
- setExtension(String, String) - Static method in class com.xmlmind.util.URIComponent
-
- setExtension(URL, String) - Static method in class com.xmlmind.util.URLUtil
-
- setFavicon(URL) - Method in class com.xmlmind.whc.Compiler
-
Specifies the favicon which is to be added to an XHTML page decorated
by the compiler.
- 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
-
- 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
-
- StoppableThread - Class in com.xmlmind.util
-
- 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
-
- 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
.
- 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
-
- 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.