diamondedge.util
Class StringSplitter

java.lang.Object
  diamondedge.util.StringSplitter

All Implemented Interfaces:

Enumeration

public class StringSplitter
extends Object
implements Enumeration

The string tokenizer class allows an application to break a string into tokens.

The delimiter may be specified either at creation time or on a per-token basis.

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

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

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

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

prints the following output:

     this
     is
     a
     test
 

The differences between StringSplitter and StringTokenizer is that the entire delimeter must match in StringSplitter and StringTokenizer needs only one character in the string to match. Also, if there is a delimeter seen then there will always be at least one more token returned even if a delimeter immediately follows the first or it is at the end of the string. In these cases it will return an empty string.

See Also:

StringTokenizer

Constructor Summary

StringSplitter(String str)
Constructs a string tokenizer for the specified string.

StringSplitter(String str, String delim)
Constructs a string tokenizer for the specified string.

Method Summary

int	countTokens() Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception.
boolean	hasMoreElements() Returns the same value as the hasMoreTokens method.
boolean	hasMoreTokens() Tests if there are more tokens available from this tokenizer's string.
Object	nextElement() Returns the same value as the nextToken method, except that its declared return value is Object rather than String.
String	nextToken() Returns the next token from this string tokenizer.
String	nextToken(String delim) Returns the next token in this string tokenizer's string.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSplitter

public StringSplitter(String str,
                      String delim)

Constructs a string tokenizer for the specified string. All characters in the delim argument must be matched in order to separate tokens.

The delimiter is skipped and only serves as a separator between tokens.

Parameters:

str - a string to be parsed.

delim - the delimiter.

StringSplitter

public StringSplitter(String str)

Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is " ". : the space character, The delimiter itself will not be treated as a token or part of the token.

Parameters:

str - a string to be parsed.

Method Detail

hasMoreTokens

public boolean hasMoreTokens()

Tests if there are more tokens available from this tokenizer's string. If this method returns true, then a subsequent call to nextToken with no argument will successfully return a token.

Returns:

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

nextToken

public String nextToken()

Returns the next token from this string tokenizer.

Returns:

the next token from this string tokenizer.

Throws:

NoSuchElementException - if there are no more tokens in this tokenizer's string.

nextToken

public String nextToken(String delim)

Returns the next token in this string tokenizer's string. First, the string considered to be the delimiter by this StringSplitter object is changed to be the the string delim. Then the next token in the string after the current position is returned. The current position is advanced beyond the recognized token. The new delimiter remains the default after this call.

Parameters:

delim - the new delimiter.

Returns:

the next token, after switching to the new delimiter.

Throws:

NoSuchElementException - if there are no more tokens in this tokenizer's string.

hasMoreElements

public boolean hasMoreElements()

Returns the same value as the hasMoreTokens method. It exists so that this class can implement the Enumeration interface.

Specified by:

hasMoreElements in interface Enumeration

Returns:

true if there are more tokens; false otherwise.

See Also:

Enumeration, hasMoreTokens()

nextElement

public Object nextElement()

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

Specified by:

nextElement in interface Enumeration

Returns:

the next token in the string.

Throws:

NoSuchElementException - if there are no more tokens in this tokenizer's string.

See Also:

Enumeration, nextToken()

countTokens

public int countTokens()

Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception. The current position is not advanced.

Returns:

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

See Also:

nextToken()