org.mdiutil.util

Class ExtendedStringTokenizer

java.lang.Object

java.util.StringTokenizer

org.mdiutil.util.ExtendedStringTokenizer

All Implemented Interfaces:

Enumeration<Object>

public class ExtendedStringTokenizer
extends StringTokenizer

Since:

1.3.21

Constructor Summary

Constructors

Constructor and Description
ExtendedStringTokenizer(String str) Constructor.
ExtendedStringTokenizer(String str, String delim) Constructor.
ExtendedStringTokenizer(String str, String delim, boolean returnDelims) Constructor.
ExtendedStringTokenizer(String str, String delim, boolean returnDelims, boolean keepEmptyTokens) Constructor.

Method Summary

Modifier and Type	Method and Description
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 tokenizers string.
boolean	isKeepingEmptyTokens() Return true if empty tokens should be returned by the nextToken() or nextElement() methods, and used by the countTokens() method.
boolean	keepEmptyTokens(boolean keepEmptyTokens) Set if empty tokens should be returned by the nextToken() or nextElement() methods, and used by the countTokens() method.
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

ExtendedStringTokenizer

public ExtendedStringTokenizer(String str)

Constructor.

Parameters:

str - the string

ExtendedStringTokenizer

public ExtendedStringTokenizer(String str,
                               String delim)

Constructor.

Parameters:

str - the string

delim - the delimiter

ExtendedStringTokenizer

public ExtendedStringTokenizer(String str,
                               String delim,
                               boolean returnDelims)

Constructor.

Parameters:

str - the string

delim - the delimiter

returnDelims - true if the delimiters should be returned

ExtendedStringTokenizer

public ExtendedStringTokenizer(String str,
                               String delim,
                               boolean returnDelims,
                               boolean keepEmptyTokens)

Constructor.

Parameters:

str - the string

delim - the delimiter

returnDelims - true if the delimiters should be returned

keepEmptyTokens - true if empty tokens should be returned

Method Detail

keepEmptyTokens

public boolean keepEmptyTokens(boolean keepEmptyTokens)

Set if empty tokens should be returned by the nextToken() or nextElement() methods, and used by the countTokens() method. If the argument is true, the he default implementation of the StringTokenizer class will be used. This method will not change the value of isKeepingEmptyTokens() if the tokenizer has been started.

Parameters:

keepEmptyTokens - true if empty tokens should be used

Returns:

true if empty tokens should be returned

isKeepingEmptyTokens

public boolean isKeepingEmptyTokens()

Return true if empty tokens should be returned by the nextToken() or nextElement() methods, and used by the countTokens() method. If the argument is true, the he default implementation of the StringTokenizer class will be used.

Returns:

true if empty tokens should be returned

nextElement

public Object nextElement()

Returns the same value as the nextToken method, except that its declared return value is Object rather than String. Note that if isKeepingEmptyTokens() returns false, the default implementation of the StringTokenizer class will be used.

Specified by:

nextElement in interface Enumeration<Object>

Overrides:

nextElement in class StringTokenizer

Returns:

the next token in the string.

Throws:

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

nextToken

public String nextToken()

Returns the next token from this string tokenizer. Note that if isKeepingEmptyTokens() returns false, the default implementation of the StringTokenizer class will be used.

Overrides:

nextToken in class StringTokenizer

Returns:

the next token from this string tokenizer.

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.

Specified by:

hasMoreElements in interface Enumeration<Object>

Overrides:

hasMoreElements in class StringTokenizer

Returns:

true if there are more tokens, false otherwise.

See Also:

hasMoreTokens()

hasMoreTokens

public boolean hasMoreTokens()

Tests if there are more tokens available from this tokenizers string. If this method returns true, then a subsequent call to nextToken with no argument will successfully return a token. Note that if isKeepingEmptyTokens() returns false, the default implementation of the StringTokenizer class will be used.

Overrides:

hasMoreTokens in class StringTokenizer

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(String delim)

Returns the next token in this string tokenizer's string. The default implementation of the StringTokenizer class will be used.

Overrides:

nextToken in class StringTokenizer

Parameters:

delim - the new delimiters

Returns:

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

Throws:

UnsupportedOperationException - if isKeepingEmptyTokens() returns true

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

NullPointerException - if delim is null

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. Note that if isKeepingEmptyTokens() returns false, the default implementation of the StringTokenizer class will be used.

Overrides:

countTokens in class StringTokenizer

Returns:

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