com.iplanet.jato.util
Class StringTokenizer2

java.lang.Object
  |
  +--com.iplanet.jato.util.StringTokenizer2
All Implemented Interfaces:
java.util.Enumeration, java.util.Iterator

public class StringTokenizer2
extends java.lang.Object
implements java.util.Enumeration, java.util.Iterator

A complement to java.util.StringTokenizer that provides tokenizing by substrings instead of single characters as well as static utility methods for standard tasks. This class is semantically compatible with StringTokenizer. There is not a default delimiter as there is with java.util.StringTokenizer. There is only a single delimiter whereas java.util.StringTokenizer allows for multiple characters. The delimiter may be optionally case sensitive.

Version:
JATO/1.2.2 $Id: StringTokenizer2.java,v 1.9 2002/03/16 03:26:39 todd Exp $
See Also:
"java.util.StringTokenizer"

Constructor Summary
StringTokenizer2(java.lang.String text, java.lang.String delimiter)
          Create tokenizer with property returnTokens set to false and property ignoreCase set to false.
StringTokenizer2(java.lang.String text, java.lang.String delimiter, boolean returnTokens)
          Create tokenizer with option for property returnTokens and property ignoreCase set to false.
StringTokenizer2(java.lang.String text, java.lang.String delimiter, boolean returnTokens, boolean ignoreCase)
          Create tokenizer with options for properties returnTokens and ignoreCase.
 
Method Summary
 int countTokens()
           
 boolean hasMoreElements()
           
 boolean hasMoreTokens()
           
 boolean hasNext()
           
 java.lang.Object next()
           
 java.lang.Object nextElement()
           
 java.lang.String nextToken()
           
 void remove()
          Feature not supported
static java.lang.String replace(java.lang.String str, java.lang.String findValue, java.lang.String replaceValue)
          Performs a classic string find and replace
static java.lang.String replace(java.lang.String str, java.lang.String findValue, java.lang.String replaceValue, boolean ignoreCase)
          Performs a classic string find & replace, optionally ignoring the case of the string
static java.lang.String[] tokenize(java.lang.String str, java.lang.String findValue)
          Shortcut to generalized search method with property trim set to false and property ignoreCase set to false
static java.lang.String[] tokenize(java.lang.String str, java.lang.String findValue, boolean trim)
          Shortcut to generalized search method with property ignoreCase set to false
static java.lang.String[] tokenize(java.lang.String str, java.lang.String findValue, boolean trim, boolean ignoreCase)
          Utility method to create array of string tokens with optional support for trimming results and ignoring case when searching.
static java.lang.String[] tokenizeLines(java.lang.String string)
          Utility method to breakup larger string into array of strings, one string per line.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringTokenizer2

public StringTokenizer2(java.lang.String text,
                        java.lang.String delimiter)
Create tokenizer with property returnTokens set to false and property ignoreCase set to false. Blank delimiter results in the entire text as a single token.
Parameters:
text - string to be parsed (must not be null)
delimiter - to be be used to tokenize text (must not be null)

StringTokenizer2

public StringTokenizer2(java.lang.String text,
                        java.lang.String delimiter,
                        boolean returnTokens)
Create tokenizer with option for property returnTokens and property ignoreCase set to false. Blank delimiter results in the entire text as a single token.
Parameters:
text - string to be parsed (must not be null)
delimiter - to be be used to tokenize text (must not be null)
returnTokens - mimics java.util.StringTokenizer in that when true delimiters are returned as tokens

StringTokenizer2

public StringTokenizer2(java.lang.String text,
                        java.lang.String delimiter,
                        boolean returnTokens,
                        boolean ignoreCase)
Create tokenizer with options for properties returnTokens and ignoreCase. Blank delimiter results in the entire text as a single token.
Parameters:
text - string to be parsed (must not be null)
delimiter - to be be used to tokenize text (must not be null)
returnTokens - mimics java.util.StringTokenizer in that when true delimiters are returned as tokens
ignoreCase - delimiters not case sensitive when true
Method Detail

hasNext

public boolean hasNext()
Specified by:
hasNext in interface java.util.Iterator
See Also:
"java.util.StringTokenizer.hasNext()"

next

public java.lang.Object next()
Specified by:
next in interface java.util.Iterator
See Also:
"java.util.StringTokenizer.next()"

remove

public void remove()
Feature not supported
Specified by:
remove in interface java.util.Iterator

hasMoreTokens

public boolean hasMoreTokens()
See Also:
"java.util.StringTokenizer.hasMoreTokens()"

hasMoreElements

public boolean hasMoreElements()
Specified by:
hasMoreElements in interface java.util.Enumeration
See Also:
"java.util.StringTokenizer.hasMoreElements()"

countTokens

public int countTokens()
See Also:
"java.util.StringTokenizer.countTokens()"

nextToken

public java.lang.String nextToken()
See Also:
"java.util.StringTokenizer.nextToken()"

nextElement

public java.lang.Object nextElement()
Specified by:
nextElement in interface java.util.Enumeration
See Also:
"java.util.StringTokenizer.nextElement()"

replace

public static java.lang.String replace(java.lang.String str,
                                       java.lang.String findValue,
                                       java.lang.String replaceValue)
Performs a classic string find and replace
Parameters:
str - original string to be modified
findValue - text to be replaced throughout string (must not be null)
replaceValue - text to replace found tokens (must not be null)
Returns:
modified string

replace

public static java.lang.String replace(java.lang.String str,
                                       java.lang.String findValue,
                                       java.lang.String replaceValue,
                                       boolean ignoreCase)
Performs a classic string find & replace, optionally ignoring the case of the string
Parameters:
str - original string to be modified
findValue - search text to be replaced throughout string (must not be null)
replaceValue - text to replace found tokens (must not be null)
ignoreCase - search text case insensitive when true
Returns:
modified string

tokenize

public static java.lang.String[] tokenize(java.lang.String str,
                                          java.lang.String findValue)
Shortcut to generalized search method with property trim set to false and property ignoreCase set to false

tokenize

public static java.lang.String[] tokenize(java.lang.String str,
                                          java.lang.String findValue,
                                          boolean trim)
Shortcut to generalized search method with property ignoreCase set to false

tokenize

public static java.lang.String[] tokenize(java.lang.String str,
                                          java.lang.String findValue,
                                          boolean trim,
                                          boolean ignoreCase)
Utility method to create array of string tokens with optional support for trimming results and ignoring case when searching.
Parameters:
str - text to be searched (must not be null)
findValue - search string (must not be null)
trim - flag indicating that resulting tokens should be trimmed
ignoreCase - flag indicating that search should be case insensitive
Returns:
array of string tokens resulting from search

tokenizeLines

public static java.lang.String[] tokenizeLines(java.lang.String string)
Utility method to breakup larger string into array of strings, one string per line.