Java Doc for StringTokenizer.java in  » Internationalization-Localization » icu4j » com » ibm » icu » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The string tokenizer class allows an application to break a string into tokens by performing code point comparison. The StringTokenizer methods do not distinguish among identifiers, numbers, and quoted strings, nor do they recognize and skip comments.

The set of delimiters (the codepoints that separate tokens) may be specified either at creation time or on a per-token basis.

An instance of StringTokenizer behaves in one of three ways, depending on whether it was created with the returnDelims and coalesceDelims flags having the value true or false:

• If returnDelims is false, delimiter code points serve to separate tokens. A token is a maximal sequence of consecutive code points that are not delimiters.
• If returnDelims is true, delimiter code points are themselves considered to be tokens. In this case, if coalesceDelims is true, such tokens will be the maximal sequence of consecutive code points that are delimiters. If coalesceDelims is false, a token will be received for each delimiter code point.

A token is thus either one delimiter code point, a maximal sequence of consecutive code points that are delimiters, or a maximal sequence of consecutive code points that are not delimiters.

A StringTokenizer object internally maintains a current position within the string to be tokenized. Some operations advance this current position past the code point processed.

A token is returned by taking a substring of the string that was used to create the StringTokenizer object.

Example of the use of the default delimiter tokenizer.

 StringTokenizer st = new StringTokenizer("this is a test");
 while (st.hasMoreTokens()) {
 println(st.nextToken());
 }
 

prints the following output:

 this
 is
 a
 test
 

Example of the use of the tokenizer with user specified delimiter.

 StringTokenizer st = new StringTokenizer(
 "this is a test with supplementary characters \ud800\ud800\udc00\udc00",
 " \ud800\udc00");
 while (st.hasMoreTokens()) {
 println(st.nextToken());
 }
 

prints the following output:

 this
 is
 a
 test
 with
 supplementary
 characters
 \ud800
 \udc00
 

Constructs a string tokenizer for the specified string.

Constructs a string tokenizer for the specified string.

Constructs a string tokenizer for the specified string.

Constructs a string tokenizer for the specified string.

Constructs a string tokenizer for the specified string.

Constructs a string tokenizer for the specified string.

Constructs a string tokenizer for the specified string.

Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens.

If the returnDelims flag is false, the delimiter characters are skipped and only serve as separators between tokens.

If the returnDelims flag is true, then the delimiter characters are also returned as tokens, one per delimiter.
Parameters:
  str - a string to be parsed.
Parameters:
  delim - the delimiters.
Parameters:
  returndelims - flag indicating whether to return the delimiters as tokens. throws a NullPointerException if str is null

Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens.

If the returnDelims flag is false, the delimiter characters are skipped and only serve as separators between tokens.

If the returnDelims flag is true, then the delimiter characters are also returned as tokens. If coalescedelims is true, one token is returned for each run of delimiter characters, otherwise one token is returned per delimiter. Since surrogate pairs can be delimiters, the returned token might be two chars in length.

Constructs a string tokenizer for the specified string. The characters in the delim argument are the delimiters for separating tokens.

Delimiter characters themselves will not be treated as tokens.

Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens.

If the returnDelims flag is false, the delimiter characters are skipped and only serve as separators between tokens.

If the returnDelims flag is true, then the delimiter characters are also returned as tokens, one per delimiter.
Parameters:
  str - a string to be parsed.
Parameters:
  delim - the delimiters.
Parameters:
  returndelims - flag indicating whether to return the delimiters as tokens. throws a NullPointerException if str is null

Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens.

If the returnDelims flag is false, the delimiter characters are skipped and only serve as separators between tokens.

If the returnDelims flag is true, then the delimiter characters are also returned as tokens. If coalescedelims is true, one token is returned for each run of delimiter characters, otherwise one token is returned per delimiter. Since surrogate pairs can be delimiters, the returned token might be two chars in length.

Constructs a string tokenizer for the specified string. The characters in the delim argument are the delimiters for separating tokens.

Delimiter characters themselves will not be treated as tokens.

Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is " \t\n\r\f": the space character, the tab character, the newline character, the carriage-return character, and the form-feed character.

Delimiter characters themselves will not be treated as tokens.