wt.util
Class QuotedStringTokenizer

java.lang.Object
  wt.util.QuotedStringTokenizer

All Implemented Interfaces:

Enumeration

public class QuotedStringTokenizer

extends Object

implements Enumeration

The quoted string tokenizer class is a string tokenizer that understands quoted substrings and does not include them as delimiters.

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

     QuotedStringTokenizer st = new QuotedStringTokenizer("\"this is a test\" this is only a test \"in the case of a real emergency\"");
     while (st.hasMoreTokens()) 
     {
         println(st.nextToken());
     }
 

prints the following output:

     this is a test
     this
     is
     only
     a
     test
     in the case of a real emergency
 

Since:

Windchill R6

See Also:

StringTokenizer

Field Summary

private int	currentPosition
private String	delimiters
private int	maxPosition
private String	quotes
private boolean	retQuotes
private boolean	retTokens
private String	str

Constructor Summary

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

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

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

QuotedStringTokenizer(String str, String delim, String quotes, boolean returnTokens, boolean returnQuotes)
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.
static void	main(String[] args)
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.
private void	skipDelimiters() Skips delimiters.

Methods inherited from class java.lang.Object

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

Field Detail

currentPosition

private int currentPosition

maxPosition

private int maxPosition

str

private String str

delimiters

private String delimiters

quotes

private String quotes

retTokens

private boolean retTokens

retQuotes

private boolean retQuotes

Constructor Detail

QuotedStringTokenizer

public QuotedStringTokenizer(String str,
                             String delim,
                             String quotes,
                             boolean returnTokens,
                             boolean returnQuotes)

Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens. Delimiters within quotes will not be considered while tokenizing.

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.

quotes - the quotes characters.

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

QuotedStringTokenizer

public QuotedStringTokenizer(String str,
                             String delim,
                             boolean returnTokens)

Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens. A quotes string of "\"" is used.

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.

QuotedStringTokenizer

public QuotedStringTokenizer(String str,
                             String delim)

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. A quotes string of "\"" is used.

Parameters:

str - a string to be parsed.

delim - the delimiters.

QuotedStringTokenizer

public QuotedStringTokenizer(String str)

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. A quotes string of "\"" is used.

Parameters:

str - a string to be parsed.

Method Detail

skipDelimiters

private void skipDelimiters()

Skips delimiters.

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 set of characters considered to be delimiters by this StringTokenizer object is changed to be the characters in 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 set remains the default after this call.

Parameters:

delim - the new delimiters.

Returns:

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

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, StringTokenizer.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, StringTokenizer.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:

StringTokenizer.nextToken()

main

public static void main(String[] args)