StringTable Chilkat2 Java Reference Documentation
StringTable
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.StringTable
Store a list of strings in insertion order and retrieve individual
entries by zero-based index.
Add strings directly, append strings from a file, or load line-delimited
text from a
Find entries containing a substring or matching a wildcard pattern when
filtering or locating text values.
Sort the string collection when deterministic ordering or user-facing
display order is needed.
Split delimited text into separate string-table entries for easier
indexing, searching, sorting, or saving.
Convert the table back to line-delimited text, copy it to a
For an extended overview, see
StringTable Class Overview.
Store, load, search, sort, split, retrieve, and save ordered lists of strings.
Chilkat.StringTable is a simple ordered collection of strings.
It can append strings directly, load one string per line from files or
StringBuilder, search for substrings or wildcard matches, sort
the collection, split strings into entries, retrieve strings by index, export
the table as line-delimited text, and save the result to a file.
Ordered string collection
Append and import
StringBuilder.
Search strings
Sort entries
Split into entries
Export and save
StringBuilder, or save the collection to a file.
StringTable when application code needs a lightweight
ordered list of text values. Append or load the strings, search or sort as
needed, retrieve entries by index with StringAt or
StringAtSb, then export the final list as line-delimited text or
save it to a file.
Object Creation
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.StringTable;
try (StringTable stringTable = new StringTable()) {
// ... use stringTable ...
} catch (ChilkatException e) {
System.out.println(e.getMessage()); // "StringTable.someMethod failed: <reason>"
System.out.println(e.getLastErrorText()); // the full log of the failed call
}Creates the underlying native Chilkat object. The native library (chilkat2java) is loaded the first time any Chilkat2 object is created; see the README in the download for where it is looked for (-Dchilkat2.library.path, a classpath resource, or java.library.path).
Releases the native object (StringTable is AutoCloseable, so try-with-resources calls it). Calling it again does nothing; any other method or property accessor called afterwards throws IllegalStateException. An object that is never closed is freed by a background cleaner once it becomes unreachable, but the garbage collector does not see native memory, so closing is the normal path. Objects returned by methods are owned by the caller too.
Returns true once close() has been called.
Errors
A method that fails throws ChilkatException, an unchecked exception carrying getClassName(), getMethodName(), getReason() (one line, also in the message) and getLastErrorText() (the full log, captured at the moment of the failure). The object remains usable. Methods that look something up and find nothing return null instead of throwing (each such method says so), and methods that answer a question (hasMember, isUnlocked, ...) return a plain boolean. Property accessors do not throw for Chilkat reasons.
A null string or object argument throws NullPointerException naming the parameter (except where a method documents that null is accepted), and a string containing U+0000 throws IllegalArgumentException.
Use an object from one thread at a time; it may be handed from one thread to another. The one cross-thread operation is setting setAbortCurrent(true) on an object that is busy in another thread (on the classes that have AbortCurrent). Unlocking: call new Global().unlockBundle("...") once at startup.
Properties
Count
int getCount()
The number of strings in the table.
topDebugLogFilePath
String getDebugLogFilePath()
void setDebugLogFilePath(String value)
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
String getLastErrorHtml()
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
String getLastErrorText()
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
String getLastErrorXml()
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
boolean getLastMethodSuccess()
void setLastMethodSuccess(boolean value)
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
VerboseLogging
boolean getVerboseLogging()
void setVerboseLogging(boolean value)
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
String getVersion()
Methods
Append
Appends a string to the table.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendFromFile
Appends strings, one per line, from a file. Each line in the path should be no longer than the length specified in maxLineLen. The charset indicates the character encoding of the contents of the file, such as utf-8, iso-8859-1, Shift_JIS, etc.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendFromSb
Appends strings, one per line, from the contents of a StringBuilder object.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
Clear
Removes all the strings from the table.
topFindMatch
This string table object holds strings with wildcards. The method returns the index of the wildcarded string that matches the text in sb, or -1 if no match is found. caseSensitive specifies whether the matching should be case-sensitive.
FindSubstring
Return the index of the first string in the table containing substr. Begins searching strings starting at startIndex. If caseSensitive is true, then the search is case sensitive. If caseSensitive is false then the search is case insensitive. Returns -1 if the substr is not found.
GetStrings
Return the number of strings specified by count, one per line, starting at startIdx. To return the entire table, pass 0 values for both startIdx and count. Set crlf equal to true to emit with CRLF line endings, or false to emit LF-only line endings. The last string is emitted includes the line ending.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
IntAt
Returns the Nth string in the table, converted to an integer value. The index is 0-based. (The first string is at index 0.) Returns -1 if no string is found at the specified index. Returns 0 if the string at the specified index exist, but is not an integer.
SaveToFile
Saves the string table to a file. The charset is the character encoding to use, such as utf-8, iso-8859-1, windows-1252, Shift_JIS, gb2312, etc. If bCrlf is true, then CRLF line endings are used, otherwise LF-only line endings are used.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
Sort
Sorts the strings in the collection in ascending or descending order. To sort in ascending order, set ascending to true, otherwise set ascending equal to false.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
SplitAndAppend
Splits a string into parts based on a single character delimiterChar. If exceptDoubleQuoted is true, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is true, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
StringAt
Returns the Nth string in the table. The index is 0-based. (The first string is at index 0.)
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
StringAtSb
Appends the Nth string in the table to sb. The index is 0-based. (The first string is at index 0.)
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
ToSb
Appends the entire string table to sb using CRLF line endings.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
WordFollowing
The method performs a case-insensitive search to return the index of a table entry matching sb, or -1 if there is no match. Set captureEmailAddr to true if the target word is expected to be an email address, otherwise set captureEmailAddr to false. sbWord will receive the word (email address) following the matched text.
This method helps replace the outdated Chilkat Bounce class, which was used for identifying and categorizing bounced email types.