Package java.util

Class StringTokenizer

java.lang.Object
java.util.StringTokenizer
All Implemented Interfaces:
Enumeration<Object>
public class StringTokenizer
extends Object
implements Enumeration<Object>
Breaks a string into tokens; new code should probably use String.split(java.lang.String). 
 // Legacy code:
 StringTokenizer st = new StringTokenizer("a:b:c", ":");
 while (st.hasMoreTokens()) {
     System.err.println(st.nextToken());
 }

 // New code:
 for (String token : "a:b:c".split(":")) {
     System.err.println(token);
 }
Since:
1.0

  • Constructor Summary

    Constructors
    Constructor Description
    StringTokenizer​(String string)
    Constructs a new StringTokenizer for the parameter string using whitespace as the delimiter.
    StringTokenizer​(String string, String delimiters)
    Constructs a new StringTokenizer for the parameter string using the specified delimiters.
    StringTokenizer​(String string, String delimiters, boolean returnDelimiters)
    Constructs a new StringTokenizer for the parameter string using the specified delimiters, returning the delimiters as tokens if the parameter returnDelimiters is true.

  • Method Summary

    Modifier and Type Method Description
    int countTokens()
    Returns the number of unprocessed tokens remaining in the string.
    boolean hasMoreElements()
    Returns true if unprocessed tokens remain.
    boolean hasMoreTokens()
    Returns true if unprocessed tokens remain.
    Object nextElement()
    Returns the next token in the string as an Object.
    String nextToken()
    Returns the next token in the string as a String.
    String nextToken​(String delims)
    Returns the next token in the string as a String.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StringTokenizer

      public StringTokenizer​(String string)
      Constructs a new StringTokenizer for the parameter string using whitespace as the delimiter. The returnDelimiters flag is set to false.
      Parameters:
      string - the string to be tokenized.

    • StringTokenizer

      public StringTokenizer​(String string, String delimiters)
      Constructs a new StringTokenizer for the parameter string using the specified delimiters. The returnDelimiters flag is set to false. If delimiters is null, this constructor doesn't throw an Exception, but later calls to some methods might throw a NullPointerException.
      Parameters:
      string - the string to be tokenized.
      delimiters - the delimiters to use.

    • StringTokenizer

      public StringTokenizer​(String string, String delimiters, boolean returnDelimiters)
      Constructs a new StringTokenizer for the parameter string using the specified delimiters, returning the delimiters as tokens if the parameter returnDelimiters is true. If delimiters is null this constructor doesn't throw an Exception, but later calls to some methods might throw a NullPointerException.
      Parameters:
      string - the string to be tokenized.
      delimiters - the delimiters to use.
      returnDelimiters - true to return each delimiter as a token.

  • Method Details

    • countTokens

      public int countTokens()
      Returns the number of unprocessed tokens remaining in the string.
      Returns:
      number of tokens that can be retreived before an Exception will result from a call to nextToken().

    • hasMoreElements

      public boolean hasMoreElements()
      Returns true if unprocessed tokens remain. This method is implemented in order to satisfy the Enumeration interface.
      Specified by:
      hasMoreElements in interface Enumeration<Object>
      Returns:
      true if unprocessed tokens remain.
      See Also:
      Enumeration.nextElement()

    • hasMoreTokens

      public boolean hasMoreTokens()
      Returns true if unprocessed tokens remain.
      Returns:
      true if unprocessed tokens remain.

    • nextElement

      public Object nextElement()
      Returns the next token in the string as an Object. This method is implemented in order to satisfy the Enumeration interface.
      Specified by:
      nextElement in interface Enumeration<Object>
      Returns:
      next token in the string as an Object
      Throws:
      NoSuchElementException - if no tokens remain.
      See Also:
      Enumeration.hasMoreElements()

    • nextToken

      public String nextToken()
      Returns the next token in the string as a String.
      Returns:
      next token in the string as a String.
      Throws:
      NoSuchElementException - if no tokens remain.

    • nextToken

      public String nextToken​(String delims)
      Returns the next token in the string as a String. The delimiters used are changed to the specified delimiters.
      Parameters:
      delims - the new delimiters to use.
      Returns:
      next token in the string as a String.
      Throws:
      NoSuchElementException - if no tokens remain.