Package com.twelvemonkeys.util

Class StringTokenIterator

  • All Implemented Interfaces:
    TokenIterator, java.util.Enumeration<java.lang.String>, java.util.Iterator<java.lang.String>
    public class StringTokenIterator
extends AbstractTokenIterator
    StringTokenIterator, a drop-in replacement for StringTokenizer. StringTokenIterator has the following features:
    • Iterates over a strings, 20-50% faster than StringTokenizer (and magnitudes faster than String.split(..) or Pattern.split(..))
    • Implements the Iterator interface
    • Optionally returns delimiters
    • Optionally returns empty elements
    • Optionally iterates in reverse
    • Resettable
    Version:
    $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/StringTokenIterator.java#1 $
    Author:
    Harald Kuhr, last modified by $Author: haku $
    See Also:
    StringTokenizer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FORWARD  
      static int REVERSE  

    • Constructor Summary

      Constructors 
      Constructor Description
      StringTokenIterator​(java.lang.String pString)
      Creates a StringTokenIterator
      StringTokenIterator​(java.lang.String pString, java.lang.String pDelimiters)
      Creates a StringTokenIterator
      StringTokenIterator​(java.lang.String pString, java.lang.String pDelimiters, boolean pIncludeDelimiters)
      Creates a StringTokenIterator
      StringTokenIterator​(java.lang.String pString, java.lang.String pDelimiters, int pDirection)
      Creates a StringTokenIterator
      StringTokenIterator​(java.lang.String pString, java.lang.String pDelimiters, int pDirection, boolean pIncludeDelimiters, boolean pIncludeEmpty)
      Creates a StringTokenIterator

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean hasNext()
      Returns true if the iteration has more elements.
      java.lang.String next()
      Returns the next element in the iteration.
      void reset()
      Resets this iterator.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Enumeration

        asIterator

      • Methods inherited from interface java.util.Iterator

        forEachRemaining

    • Constructor Detail

      • StringTokenIterator

        public StringTokenIterator​(java.lang.String pString)
        Creates a StringTokenIterator
        Parameters:
        pString - the string to be parsed.

      • StringTokenIterator

        public StringTokenIterator​(java.lang.String pString,
                           java.lang.String pDelimiters)
        Creates a StringTokenIterator
        Parameters:
        pString - the string to be parsed.
        pDelimiters - the delimiters.

      • StringTokenIterator

        public StringTokenIterator​(java.lang.String pString,
                           java.lang.String pDelimiters,
                           int pDirection)
        Creates a StringTokenIterator
        Parameters:
        pString - the string to be parsed.
        pDelimiters - the delimiters.
        pDirection - iteration direction.

      • StringTokenIterator

        public StringTokenIterator​(java.lang.String pString,
                           java.lang.String pDelimiters,
                           boolean pIncludeDelimiters)
        Creates a StringTokenIterator
        Parameters:
        pString - the string to be parsed.
        pDelimiters - the delimiters.
        pIncludeDelimiters - flag indicating whether to return delimiters as tokens.

      • StringTokenIterator

        public StringTokenIterator​(java.lang.String pString,
                           java.lang.String pDelimiters,
                           int pDirection,
                           boolean pIncludeDelimiters,
                           boolean pIncludeEmpty)
        Creates a StringTokenIterator
        Parameters:
        pString - the string to be parsed.
        pDelimiters - the delimiters.
        pDirection - iteration direction.
        pIncludeDelimiters - flag indicating whether to return delimiters as tokens.
        pIncludeEmpty - flag indicating whether to return empty tokens

    • Method Detail

      • reset

        public void reset()
        Resets this iterator.

      • hasNext

        public boolean hasNext()
        Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)
        Returns:
        true if the iterator has more elements.

      • next

        public java.lang.String next()
        Returns the next element in the iteration.
        Returns:
        the next element in the iteration.
        Throws:
        java.util.NoSuchElementException - iteration has no more elements.