com.softwareag.mobile.runtime.toolkit.util

Class StringTokenizer

java.lang.Object

com.softwareag.mobile.runtime.toolkit.util.StringTokenizer

All Implemented Interfaces:

java.util.Enumeration

public class StringTokenizer
extends java.lang.Object
implements java.util.Enumeration

The class StringTokenizer splits a String into tokens based on one or multiple characters used as delimiters. By optionally providing protector characters it also allows to protect regions within the String where delimiters are ignored. This could be used for example to skip tokenizing within quotes.

A new StringTokenizer can be created in the following ways:

 final StringTokenizer tokenizer = new StringTokenizer("my.qualified.name", ".");
 

 final StringTokenizer tokenizer = new StringTokenizer("my.qualified.name;protected.region;", ".", ";");
 

To get all tokens, use a while-loop in combination with hasMoreTokens() and nextToken():

 while (tokenizer.hasMoreTokens()) {
        final String token = tokenizer.nextToken();
 }
 

Version:

10.3.0.0004-0525

Constructor Summary

Constructors

Constructor and Description
StringTokenizer(java.lang.String theString, java.lang.String delimiters) Creates a new StringTokenizer by passing the String to be tokenized and a String containing the delimiter characters for tokenizing.
StringTokenizer(java.lang.String theString, java.lang.String delimiters, java.lang.String startProtectors, java.lang.String endProtectors) Creates a new StringTokenizer by passing the String to be tokenized and a String containing the delimiter characters for tokenizing.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentTokenDelimiter() Returns the delimiter character that was used for the last token extraction.
boolean	hasMoreElements()
boolean	hasMoreTokens() Tests if there are more tokens and nextToken() will return a valid (not null) token.
java.lang.Object	nextElement()
java.lang.String	nextToken() Returns the next token (substring) parsed from the current position within the given String up to the next delimiter found.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringTokenizer

public StringTokenizer(java.lang.String theString,
                       java.lang.String delimiters)

Creates a new StringTokenizer by passing the String to be tokenized and a String containing the delimiter characters for tokenizing.

Parameters:

theString - the String to be tokenized

delimiters - the characters to be used as delimiters as String

StringTokenizer

public StringTokenizer(java.lang.String theString,
                       java.lang.String delimiters,
                       java.lang.String startProtectors,
                       java.lang.String endProtectors)

Creates a new StringTokenizer by passing the String to be tokenized and a String containing the delimiter characters for tokenizing. Additionally a String of start and end protector characters is provided to control regions within theString in which the delimiters will be ignored.

In the current implementation StringTokenizer will not check for matching startProtector and endProtector if multiple characters are provided for each parameter. Each of the characters will start and end a protected region. This is a limititation that should be considered when using multiple start and end characters.

Parameters:

theString - the String to be tokenized

delimiters - the characters to be used as delimiters as String

startProtectors - the characters to be used to start a protected region

endProtectors - the characters to be used to end a protected region

Method Detail

hasMoreTokens

public boolean hasMoreTokens()

Tests if there are more tokens and nextToken() will return a valid (not null) token.

Returns:

true if and only if there is at least one token in the string after the current position; false otherwise.

getCurrentTokenDelimiter

public java.lang.String getCurrentTokenDelimiter()

Returns the delimiter character that was used for the last token extraction. Because it is possible to define multiple delimiter characters to do the tokenizing of the given string, use this method to get the delimiter that was found last.

Returns:

the delimiter used to perform the token extraction

nextToken

public java.lang.String nextToken()

Returns the next token (substring) parsed from the current position within the given String up to the next delimiter found. If there is no more token, null will be returned. Use hasMoreTokens() to check if there are any more tokens before calling this method. To get the delimiter character that was found to determine the end of the token use getCurrentTokenDelimiter().

Returns:

the next token as String.

hasMoreElements

public boolean hasMoreElements()

Specified by:

hasMoreElements in interface java.util.Enumeration

See Also:

hasMoreTokens()

nextElement

public java.lang.Object nextElement()

Specified by:

nextElement in interface java.util.Enumeration

See Also:

nextToken()