---
product: Chilkat
product_version: 11.7.0
language: ckjava
language_label: Java
class: StringTable
class_name: CkStringTable
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/javaCkStringTableRef.html
---
# Chilkat StringTable — Java — v11.7.0

> Chilkat 11.7.0 · language=ckjava · class=StringTable (CkStringTable)
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/StringTable.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckjava/guide.md`.

## Purpose

**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**

Store a list of strings in insertion order and retrieve individual entries by zero-based index.

**Append and import**

Add strings directly, append strings from a file, or load line-delimited text from a `StringBuilder`.

**Search strings**

Find entries containing a substring or matching a wildcard pattern when filtering or locating text values.

**Sort entries**

Sort the string collection when deterministic ordering or user-facing display order is needed.

**Split into entries**

Split delimited text into separate string-table entries for easier indexing, searching, sorting, or saving.

**Export and save**

Convert the table back to line-delimited text, copy it to a `StringBuilder`, or save the collection to a file.

**Common pattern:** Use `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.

For an extended overview, see [StringTable Class Overview](https://www.chilkatsoft.com/stringtable_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```java
CkStringTable obj = new CkStringTable();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Java.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `void get_DebugLogFilePath(CkString str); String debugLogFilePath(); void put_DebugLogFilePath(String newVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `void get_LastErrorHtml(CkString str); String lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void get_LastErrorText(CkString str); String lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void get_LastErrorXml(CkString str); String lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean get_LastMethodSuccess(); void put_LastMethodSuccess(boolean newVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `boolean get_VerboseLogging(); void put_VerboseLogging(boolean newVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void get_Version(CkString str); String version();` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Count` | property, read-only | `int get_Count();` |
| `Append` | method | `boolean Append(String value);` |
| `AppendFromFile` | method | `boolean AppendFromFile(int maxLineLen, String charset, String path);` |
| `AppendFromSb` | method | `boolean AppendFromSb(CkStringBuilder sb);` |
| `Clear` | method | `void Clear();` |
| `FindMatch` | method | `int FindMatch(CkStringBuilder sb, boolean caseSensitive);` |
| `FindSubstring` | method | `int FindSubstring(int startIndex, String substr, boolean caseSensitive);` |
| `GetStrings` | method | `boolean GetStrings(int startIdx, int count, boolean crlf, CkString outStr); String getStrings(int startIdx, int count, boolean crlf);` |
| `IntAt` | method | `int IntAt(int index);` |
| `SaveToFile` | method | `boolean SaveToFile(String charset, boolean bCrlf, String path);` |
| `Sort` | method | `boolean Sort(boolean ascending, boolean caseSensitive);` |
| `SplitAndAppend` | method | `boolean SplitAndAppend(String inStr, String delimiterChar, boolean exceptDoubleQuoted, boolean exceptEscaped);` |
| `StringAt` | method | `boolean StringAt(int index, CkString outStr); String stringAt(int index);` |
| `StringAtSb` | method | `boolean StringAtSb(int index, CkStringBuilder sb);` |
| `ToSb` | method | `boolean ToSb(CkStringBuilder sb);` |
| `WordFollowing` | method | `int WordFollowing(CkStringBuilder sb, boolean captureEmailAddr, CkStringBuilder sbWord);` |

## Properties

### StringTable.Count

`Chilkat 11.7.0 · ckjava · StringTable · Count · property · read-only · since 9.5.0.62`

```java
int get_Count();
```

The number of strings in the table.

## Methods

### StringTable.Append

`Chilkat 11.7.0 · ckjava · StringTable · Append · method · since 9.5.0.62`

```java
boolean Append(String value);
```

Appends a string to the table.

Returns true for success, false for failure.

### StringTable.AppendFromFile

`Chilkat 11.7.0 · ckjava · StringTable · AppendFromFile · method · since 9.5.0.62`

```java
boolean AppendFromFile(int maxLineLen, String charset, String path);
```

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.

Returns true for success, false for failure.

### StringTable.AppendFromSb

`Chilkat 11.7.0 · ckjava · StringTable · AppendFromSb · method · since 9.5.0.62`

```java
boolean AppendFromSb(CkStringBuilder sb);
```

Appends strings, one per line, from the contents of a StringBuilder object.

Returns true for success, false for failure.

### StringTable.Clear

`Chilkat 11.7.0 · ckjava · StringTable · Clear · method · since 9.5.0.62`

```java
void Clear();
```

Removes all the strings from the table.

### StringTable.FindMatch

`Chilkat 11.7.0 · ckjava · StringTable · FindMatch · method · since 11.1.0`

```java
int FindMatch(CkStringBuilder sb, boolean caseSensitive);
```

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.

### StringTable.FindSubstring

`Chilkat 11.7.0 · ckjava · StringTable · FindSubstring · method · since 9.5.0.77`

```java
int FindSubstring(int startIndex, String substr, boolean caseSensitive);
```

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.

### StringTable.GetStrings

`Chilkat 11.7.0 · ckjava · StringTable · GetStrings · method · since 9.5.0.87`

```java
boolean GetStrings(int startIdx, int count, boolean crlf, CkString outStr);

String getStrings(int startIdx, int count, boolean crlf);
```

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.

Returns true for success, false for failure.

### StringTable.IntAt

`Chilkat 11.7.0 · ckjava · StringTable · IntAt · method · since 9.5.0.63`

```java
int IntAt(int index);
```

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.

### StringTable.SaveToFile

`Chilkat 11.7.0 · ckjava · StringTable · SaveToFile · method · since 9.5.0.62`

```java
boolean SaveToFile(String charset, boolean bCrlf, String path);
```

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.

Returns true for success, false for failure.

### StringTable.Sort

`Chilkat 11.7.0 · ckjava · StringTable · Sort · method · since 9.5.0.87`

```java
boolean Sort(boolean ascending, boolean caseSensitive);
```

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`.

Returns true for success, false for failure.

### StringTable.SplitAndAppend

`Chilkat 11.7.0 · ckjava · StringTable · SplitAndAppend · method · since 9.5.0.62`

```java
boolean SplitAndAppend(String inStr, String delimiterChar, boolean exceptDoubleQuoted, boolean exceptEscaped);
```

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.

Returns true for success, false for failure.

### StringTable.StringAt

`Chilkat 11.7.0 · ckjava · StringTable · StringAt · method · since 9.5.0.62`

```java
boolean StringAt(int index, CkString outStr);

String stringAt(int index);
```

Returns the Nth string in the table. The `index` is 0-based. (The first string is at index 0.)

Returns true for success, false for failure.

### StringTable.StringAtSb

`Chilkat 11.7.0 · ckjava · StringTable · StringAtSb · method · since 11.2.0`

```java
boolean StringAtSb(int index, CkStringBuilder sb);
```

Appends the Nth string in the table to `sb`. The `index` is 0-based. (The first string is at index 0.)

Returns true for success, false for failure.

### StringTable.ToSb

`Chilkat 11.7.0 · ckjava · StringTable · ToSb · method · since 11.3.0`

```java
boolean ToSb(CkStringBuilder sb);
```

Appends the entire string table to `sb` using CRLF line endings.

Returns true for success, false for failure.

### StringTable.WordFollowing

`Chilkat 11.7.0 · ckjava · StringTable · WordFollowing · method · since 11.1.0`

```java
int WordFollowing(CkStringBuilder sb, boolean captureEmailAddr, CkStringBuilder sbWord);
```

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.

## Related classes

[`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckjava/classes/StringBuilder.md)

