gate.util
Class StrTokeniser

java.lang.Object
  |
  +--gate.util.StrTokeniser
All Implemented Interfaces:
Enumeration

public class StrTokeniser
extends Object
implements Enumeration


Constructor Summary
StrTokeniser(String str)
          Constructs a string tokenizer for the specified string.
StrTokeniser(String str, String delim)
          Constructs a string tokenizer for the specified string.
StrTokeniser(String str, String delim, boolean returnTokens)
          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.
 int getCurrentPosition()
          Returns the current position of the tikeniser so it can be used for calculating the offset.
 boolean hasMoreElements()
          Returns the same value as the hasMoreTokens method.
 boolean hasMoreTokens()
          Tests if there are more tokens available from this tokenizer's string.
 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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StrTokeniser

public StrTokeniser(String str,
                    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

StrTokeniser

public StrTokeniser(String str,
                    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

StrTokeniser

public StrTokeniser(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 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.
Since:
JDK1.0

nextToken

public String nextToken(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:
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 Enumeration
Returns:
true if there are more tokens; false otherwise.
Since:
JDK1.0
See Also:
Enumeration, java.util.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.
Since:
JDK1.0
See Also:
Enumeration, java.util.StringTokenizer#nextToken()

getCurrentPosition

public int getCurrentPosition()
Returns the current position of the tikeniser so it can be used for calculating the offset. That's the only difference from the original StringTokenizer class from the jdk.

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
See Also:
java.util.StringTokenizer#nextToken()