Package java.util

Previous

Java API

Index

Next

Class StringTokenizer

public  class  java.util.StringTokenizer
    extends  java.lang.Object  
    implements java.util.Enumeration  
{
        // Constructors
    public StringTokenizer(String  str);	
    public StringTokenizer(String  str, String  delim);	
    public StringTokenizer(String  str, String  delim,	
                                      boolean  returnTokens);
        // Methods
    public int countTokens();	
    public boolean hasMoreElements();	
    public boolean hasMoreTokens();	
    public Object nextElement();	
    public String nextToken();	
    public String nextToken(String  delim);	
}

The string tokenizer class allows an application to break a string into tokens. The tokenization method is much simpler than the one used by the StreamTokenizer class . The StringTokenizer methods do not distinguish among identifiers, numbers, and quoted strings, not does it recognize and skip comments.

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

An instance of StringTokenizer behaves in one of two ways, depending on whether it was created with the returnTokens flag having the value true or false:

• If the flag is false, delimiter characters merely serve to separate tokens. A token is a maximal sequence of consecutive characters that are delimiters.
• If the flag is true, delimiters characters are considered to be tokens. A token is either one delimiter character, or a maximal sequence of consecutive characters that are not delimiters.

The following is one example of the use of the tokenizer. The code

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

Prints the following output:

this
is
a
test 

Constructors

StringTokenizer

public StringTokenizer(String  str) 

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

Parameter	Description
str	a string to be parsed

StringTokenizer

public StringTokenizer(String  str, String  delim) 

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

Parameter	Description
str	a string to be parsed
delim	the delimiters

StringTokenizer

public StringTokenizer(String  str, String  delim,
                                              boolean  returnTokens) 

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

If the returnTokens flag is true, then the delimiter characters are also returned as tokens. Each delimiter is returned as a string of length one. If the flag is false, the delimiter characters are skipped and only serve as separators between tokens.

Parameter	Description
str	a string to be parsed
delim	the delimiters
returnTokens	flag indicating whether to return the delimiters as tokens.

Methods

countTokens

public int countTokens() 

Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception.

Return Value:

Returns the number of tokens remaining in the string using thie current delimiter set.

hasMoreElements

public boolean hasMoreElements() 

This method returns the same value as the following hasMoreTokens method. It exists so that this class can implement the enumeration interface.

Return Value:

Returns true if there are more tokens; false otherwise

hasMoreTokens

public boolean hasMoreTokens() 

Return Value:

Returns true if there are more tokens available from this tokenizer's string; false otherwise

nextElement

public Object nextElement() 

This method returns the same value as the following nextToken method, except that its declared return value is Object rather than String. It exists so that this class can implement the enumeration interface.

Return Value:

Returns the next token in the string.

Throw:

NoSuchElementException

If there are no more tokens in this tokenizer's string.

nextToken

public String nextToken() 

Return Value:

Returns the next token from this string tokenizer.

Throw:

NoSuchElementException

If there are no more tokens in this tokenizer's string.

nextToken

public String nextToken(String  delim) 

Gets the next token in this stringt tokenizer's string. The new delimiter set remains the default after this call.

Return Value:

Returns the next token, after switching to the new delimiter set.

Parameter	Description
delim	the new delimiters

Throw:

NoSuchElementException

If there are no more tokens in the string.