java.util
Class StringTokenizer

java.lang.Object
  java.util.StringTokenizer

All Implemented Interfaces:

Enumeration<Object>

public class StringTokenizer
extends Object
implements Enumeration<Object>

String tokenizer is used to break a string apart into tokens. If returnDelimiters is false, successive calls to nextToken() return maximal blocks of characters that do not contain a delimiter. If returnDelimiters is true, delimiters are considered to be tokens, and successive calls to nextToken() return either a one character delimiter, or a maximal block of text between delimiters.

Constructor Summary

StringTokenizer(String string)
Constructs a new StringTokenizer for string using whitespace as the delimiter, returnDelimiters is false.

StringTokenizer(String string, String delimiters)
Constructs a new StringTokenizer for string using the specified delimiters, returnDelimiters is false.

StringTokenizer(String string, String delimiters, boolean returnDelimiters)
Constructs a new StringTokenizer for string using the specified delimiters and returning delimiters as tokens when specified.

Method Summary

int	countTokens() Returns the number of unprocessed tokens remaining in the string.
boolean	hasMoreElements() Returns true if unprocessed tokens remain.
boolean	hasMoreTokens() Returns true if unprocessed tokens remain.
Object	nextElement() Returns the next token in the string as an Object.
String	nextToken() Returns the next token in the string as a String.
String	nextToken(String delims) Returns the next token in the string as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringTokenizer

public StringTokenizer(String string)

Constructs a new StringTokenizer for string using whitespace as the delimiter, returnDelimiters is false.

Parameters:

string - the string to be tokenized

StringTokenizer

public StringTokenizer(String string,
                       String delimiters)

Constructs a new StringTokenizer for string using the specified delimiters, returnDelimiters is false.

Parameters:

string - the string to be tokenized

delimiters - the delimiters to use

StringTokenizer

public StringTokenizer(String string,
                       String delimiters,
                       boolean returnDelimiters)

Constructs a new StringTokenizer for string using the specified delimiters and returning delimiters as tokens when specified.

Parameters:

string - the string to be tokenized

delimiters - the delimiters to use

returnDelimiters - true to return each delimiter as a token

Method Detail

countTokens

public int countTokens()

Returns the number of unprocessed tokens remaining in the string.

Returns:

number of tokens that can be retreived before an exception will result

hasMoreElements

public boolean hasMoreElements()

Returns true if unprocessed tokens remain.

Specified by:

hasMoreElements in interface Enumeration<Object>

Returns:

true if unprocessed tokens remain

See Also:

Enumeration.nextElement()

hasMoreTokens

public boolean hasMoreTokens()

Returns true if unprocessed tokens remain.

Returns:

true if unprocessed tokens remain

nextElement

public Object nextElement()

Returns the next token in the string as an Object.

Specified by:

nextElement in interface Enumeration<Object>

Returns:

next token in the string as an Object

Throws:

NoSuchElementException - if no tokens remain

See Also:

Enumeration.hasMoreElements()

nextToken

public String nextToken()

Returns the next token in the string as a String.

Returns:

next token in the string as a String

Throws:

NoSuchElementException - if no tokens remain

nextToken

public String nextToken(String delims)

Returns the next token in the string as a String. The delimiters used are changed to the specified delimiters.

Parameters:

delims - the new delimiters to use

Returns:

next token in the string as a String

Throws:

NoSuchElementException - if no tokens remain