public class

StringTokenizer

extends Object
implements Enumeration<E>
java.lang.Object
   ↳ java.util.StringTokenizer

Class Overview

Breaks a string into tokens; new code should probably use split(String). 

 // Legacy code:
 StringTokenizer st = new StringTokenizer("a:b:c", ":");
 while (st.hasMoreTokens()) {
     System.err.println(st.nextToken());
 }
 // New code:
 for (String token : "a:b:c".split(":")) {
     System.err.println(token);
 }

Summary

Public Constructors
StringTokenizer(String string)
Constructs a new StringTokenizer for the parameter string using whitespace as the delimiter.
StringTokenizer(String string, String delimiters)
Constructs a new StringTokenizer for the parameter string using the specified delimiters.
StringTokenizer(String string, String delimiters, boolean returnDelimiters)
Constructs a new StringTokenizer for the parameter string using the specified delimiters, returning the delimiters as tokens if the parameter returnDelimiters is true.
Public Methods
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(String delims)
Returns the next token in the string as a String.
String nextToken()
Returns the next token in the string as a String.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Enumeration

Public Constructors

public StringTokenizer (String string)

Since: API Level 1

Constructs a new StringTokenizer for the parameter string using whitespace as the delimiter. The returnDelimiters flag is set to false.

Parameters
string the string to be tokenized.

public StringTokenizer (String string, String delimiters)

Since: API Level 1

Constructs a new StringTokenizer for the parameter string using the specified delimiters. The returnDelimiters flag is set to false. If delimiters is null, this constructor doesn't throw an Exception, but later calls to some methods might throw a NullPointerException.

Parameters
string the string to be tokenized.
delimiters the delimiters to use.

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

Since: API Level 1

Constructs a new StringTokenizer for the parameter string using the specified delimiters, returning the delimiters as tokens if the parameter returnDelimiters is true. If delimiters is null this constructor doesn't throw an Exception, but later calls to some methods might throw a NullPointerException.

Parameters
string the string to be tokenized.
delimiters the delimiters to use.
returnDelimiters true to return each delimiter as a token.

Public Methods

public int countTokens ()

Since: API Level 1

Returns the number of unprocessed tokens remaining in the string.

Returns
  • number of tokens that can be retreived before an Exception will result from a call to nextToken().

public boolean hasMoreElements ()

Since: API Level 1

Returns true if unprocessed tokens remain. This method is implemented in order to satisfy the Enumeration interface.

Returns
  • true if unprocessed tokens remain.

public boolean hasMoreTokens ()

Since: API Level 1

Returns true if unprocessed tokens remain.

Returns
  • true if unprocessed tokens remain.

public Object nextElement ()

Since: API Level 1

Returns the next token in the string as an Object. This method is implemented in order to satisfy the Enumeration interface.

Returns
  • next token in the string as an Object
Throws
NoSuchElementException if no tokens remain.

public String nextToken (String delims)

Since: API Level 1

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.

public String nextToken ()

Since: API Level 1

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.