cynosurex.util
Class EnhancedStringTokenizer

java.lang.Object
  cynosurex.util.EnhancedStringTokenizer

All Implemented Interfaces:

cynosurex.internal.AuthorCommon, cynosurex.internal.CommonInterface, cynosurex.internal.CompanyCommon, java.util.Enumeration

public class EnhancedStringTokenizer
extends java.lang.Object
implements cynosurex.internal.CommonInterface, java.util.Enumeration

EnhancedStringTokenizer is an enhancement of the Java StringTokenizer class. It added the ability to peek at the next token, to return the last token, and to reset the queue.

Field Summary

Fields inherited from interface cynosurex.internal.CommonInterface

copyright, copyrightYears, notice, program, version

Fields inherited from interface cynosurex.internal.AuthorCommon

author, copyrightSymbol, noticeMsg, rights

Fields inherited from interface cynosurex.internal.CompanyCommon

company, email, website

Constructor Summary

EnhancedStringTokenizer(java.lang.String str)
Constructs a string tokenizer for the specified string.

EnhancedStringTokenizer(java.lang.String str, java.lang.String delim)
Constructs a string tokenizer for the specified string.

EnhancedStringTokenizer(java.lang.String str, java.lang.String delim, boolean returnTokens)
Constructs a string tokenizer for the specified string.

EnhancedStringTokenizer(java.lang.String str, java.lang.String delim, boolean returnTokens, boolean multiDelim)
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.
java.lang.String	lastToken() Method to return the last token in the queue.
java.lang.Object	nextElement() Returns the same value as the nextToken method, except that its declared return value is Object rather than String.
java.lang.String	nextToken() Returns the next token from this string tokenizer.
java.lang.String	nextToken(java.lang.String delim) Returns the next token in this string tokenizer's string.
java.lang.String	peekToken() Method to return the next token without removing it from the queue.
void	reset() Method to return the StringTokenizer to the original queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhancedStringTokenizer

public EnhancedStringTokenizer(java.lang.String str,
                               java.lang.String delim,
                               boolean returnTokens,
                               boolean multiDelim)

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. If the flag is false, the delimiter characters are skipped and only serve as separators between tokens.

If the multiDelim flag is true, then multiple delimiters are returned as one token. If false, each delimiter is returned as a string of length one. This flag has no effect if delimiters are not returned as tokens.

Parameters:

str - a string to be parsed.

delim - the delimiters.

returnTokens - flag indicating whether to return the delimiters as tokens.

multiDelim - flag indicating whether to return multiple delimiters as one token.

Since:

CI Class Package 2.22

EnhancedStringTokenizer

public EnhancedStringTokenizer(java.lang.String str,
                               java.lang.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.

Parameters:

str - a string to be parsed.

delim - the delimiters.

returnTokens - flag indicating whether to return the delimiters as tokens.

Since:

JDK1.0

EnhancedStringTokenizer

public EnhancedStringTokenizer(java.lang.String str,
                               java.lang.String delim)

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

Parameters:

str - a string to be parsed.

delim - the delimiters.

Since:

JDK1.0

EnhancedStringTokenizer

public EnhancedStringTokenizer(java.lang.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.

Parameters:

str - a string to be parsed.

Since:

JDK1.0

Method Detail

hasMoreTokens

public boolean hasMoreTokens()

Tests if there are more tokens available from this tokenizer's string.

Returns:

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

Since:

JDK1.0

nextToken

public java.lang.String nextToken()

Returns the next token from this string tokenizer.

Returns:

the next token from this string tokenizer.

Throws:

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

Since:

JDK1.0

nextToken

public java.lang.String nextToken(java.lang.String delim)

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

Parameters:

delim - the new delimiters.

Returns:

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

Throws:

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

Since:

JDK1.0

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 java.util.Enumeration

Returns:

true if there are more tokens; false otherwise.

Since:

JDK1.0

See Also:

Enumeration

nextElement

public java.lang.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 java.util.Enumeration

Returns:

the next token in the string.

Throws:

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

Since:

JDK1.0

See Also:

Enumeration

countTokens

public int countTokens()

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

Returns:

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

Since:

JDK1.0

peekToken

public java.lang.String peekToken()

Method to return the next token without removing it from the queue.

Since:

CI Class Package 2.22

lastToken

public java.lang.String lastToken()

Method to return the last token in the queue.

Since:

CI Class Package 1.0

reset

public void reset()

Method to return the StringTokenizer to the original queue.

Since:

CI Class Package 2.22