SAFSStringTokenizer (SAFS API DOCUMENT)

java.lang.Object
- java.util.StringTokenizer
- - org.safs.SAFSStringTokenizer

All Implemented Interfaces:

java.util.Enumeration<java.lang.Object>
```
public class SAFSStringTokenizer
extends java.util.StringTokenizer
```
All Implemented Interfaces: Enumeration
--------------------------------------------------------------------------------
Note, this version extends StringTokenizer, and changes it's behavior. In this version, if two delimiters come directly next to each other, then a blank token is inserted between them. this seems to be the more appropriate implied action, as in:
X,Y,,Z
the implied output would be 4 tokens: (X), (Y), (), and (Z)
--------------------------------------------------------------------------------
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, nor do they 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 returnDelims flag having the value true or false:
If the flag is false, delimiter characters serve to separate tokens. A token is a maximal sequence of consecutive characters that are not delimiters.
If the flag is true, delimiter characters are themselves considered to be tokens. A token is thus either one delimiter character, or a maximal sequence of consecutive characters that are not delimiters.
A StringTokenizer 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 StringTokenizer object.
The following is one example of the use of the tokenizer. The code:
StringTokenizer st = new SAFSStringTokenizer("this,,is,a,test",","); while (st.hasMoreTokens()) { println(st.nextToken()); }
prints the following output:
this is a test

Since:

JUN 24, 2003
JUN 24, 2003 (DBauman) Original Release

Author:

Doug Bauman

Constructor Summary

Constructors
Constructor and Description
`SAFSStringTokenizer(java.lang.String str)` Purpose: Constructs a string tokenizer for the specified string.
`SAFSStringTokenizer(java.lang.String str, java.lang.String delim)` Purpose: Constructs a string tokenizer for the specified string.
`SAFSStringTokenizer(java.lang.String str, java.lang.String delim, boolean returnDelims)` Purpose: Constructs a string tokenizer for the specified string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`countTokens()` Purpose: Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception.
`boolean`	`hasMoreElements()` Purpose: Returns the same value as the hasMoreTokens method.
`boolean`	`hasMoreTokens()` Purpose: Tests if there are more tokens available from this tokenizer's string.
`static void`	`main(java.lang.String[] args)`
`java.lang.Object`	`nextElement()` Purpose: Returns the same value as the nextToken method, except that its declared return value is Object rather than String.
`java.lang.String`	`nextToken()` Purpose: Returns the next token from this string tokenizer.
`java.lang.String`	`nextToken(java.lang.String delim)` Purpose: 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
  - SAFSStringTokenizer
```
public SAFSStringTokenizer(java.lang.String str)
```
    Purpose: Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is " \t\n\r\f": the space character, the tab character, the newline character, the carriage-return character, and the form-feed character. Delimiter characters themselves will not be treated as tokens, but if two delimiters are next to each other, then a blank token is provided (unlike our parent).
    
    Parameters:
    
    str - a string to be parsed
  - SAFSStringTokenizer
```
public SAFSStringTokenizer(java.lang.String str,
                           java.lang.String delim)
```
    Purpose: Constructs a string tokenizer for the specified string. The characters in the delim argument are the delimiters for separating tokens. Delimiter characters themselves will not be treated as tokens, but if two delimiters are next to each other, then a blank token is provided (unlike our parent).
    
    Parameters:
    
    str - a string to be parsed
  - SAFSStringTokenizer
```
public SAFSStringTokenizer(java.lang.String str,
                           java.lang.String delim,
                           boolean returnDelims)
```
    Purpose: Constructs a string tokenizer for the specified string. The characters in the delim argument are the delimiters for separating tokens. Delimiter characters themselves will not be treated as tokens, but if two delimiters are next to each other, then a blank token is provided (unlike our parent).
    
    Parameters:
    
    str - a string to be parsed
    
    delim - the delimeters
    
    returnDelims - flag indicating whether to return the delimiters as tokens.
- Method Detail
  - countTokens
```
public int countTokens()
```
    Purpose: Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception.
    
    Overrides:
    
    countTokens in class java.util.StringTokenizer
    
    Returns:
    
    int
  - hasMoreElements
```
public boolean hasMoreElements()
```
    Purpose: Returns the same value as the hasMoreTokens method.
    
    Specified by:
    
    hasMoreElements in interface java.util.Enumeration<java.lang.Object>
    
    Overrides:
    
    hasMoreElements in class java.util.StringTokenizer
    
    Returns:
    
    boolean, true if more, false if not
  - nextElement
```
public java.lang.Object nextElement()
                             throws java.util.NoSuchElementException
```
    Purpose: 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<java.lang.Object>
    
    Overrides:
    
    nextElement in class java.util.StringTokenizer
    
    Returns:
    
    Object
    
    Throws:
    
    java.util.NoSuchElementException - - if there are no more tokens in this tokenizer's string.
  - hasMoreTokens
```
public boolean hasMoreTokens()
```
    Purpose: Tests if there are more tokens available from this tokenizer's string.
    
    Overrides:
    
    hasMoreTokens in class java.util.StringTokenizer
    
    Returns:
    
    boolean, true if more, false if not
  - nextToken
```
public java.lang.String nextToken()
                           throws java.util.NoSuchElementException
```
    Purpose: Returns the next token from this string tokenizer. except that its declared return value is Object rather than String.
    
    Overrides:
    
    nextToken in class java.util.StringTokenizer
    
    Returns:
    
    Object
    
    Throws:
    
    java.util.NoSuchElementException - - if there are no more tokens in this tokenizer's string.
  - nextToken
```
public java.lang.String nextToken(java.lang.String delim)
```
    Purpose: Returns the next token in this string tokenizer's string. Currently not implemented
    
    Overrides:
    
    nextToken in class java.util.StringTokenizer
    
    Parameters:
    
    delim, - String
    
    Returns:
    
    none
  - main
```
public static void main(java.lang.String[] args)
```

Class SAFSStringTokenizer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SAFSStringTokenizer

SAFSStringTokenizer

SAFSStringTokenizer

Method Detail

countTokens

hasMoreElements

nextElement

hasMoreTokens

nextToken

nextToken

main