Class StringTokenIterator

    • Constructor Summary

      Constructors 
      Constructor Description
      StringTokenIterator​(java.lang.String string)
      Construct a StringTokenIterator that will break the supplied string into tokens at whitespace boundaries
      StringTokenIterator​(java.lang.String string, java.lang.String delimiters)
      Construct a StringTokenIterator that will break the supplied string into tokens at any of the delimiter characters included in the delimiter string.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Close the iterator.
      StringValue current()
      Get the current item in the sequence.
      StringTokenIterator getAnother()
      Get another iterator over the same sequence of items, positioned at the start of the sequence.
      int getProperties()
      Get properties of this iterator, as a bit-significant integer.
      StringValue next()
      Get the next item in the sequence.
      int position()
      Get the current position
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StringTokenIterator

        public StringTokenIterator​(java.lang.String string)
        Construct a StringTokenIterator that will break the supplied string into tokens at whitespace boundaries
        Parameters:
        string - the string to be tokenized
      • StringTokenIterator

        public StringTokenIterator​(java.lang.String string,
                                   java.lang.String delimiters)
        Construct a StringTokenIterator that will break the supplied string into tokens at any of the delimiter characters included in the delimiter string.
        Parameters:
        string - the string to be tokenized
        delimiters - the characters that are recognized as token separators
    • Method Detail

      • close

        public void close()
        Description copied from interface: SequenceIterator
        Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.

        (Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)

        Specified by:
        close in interface SequenceIterator<StringValue>
      • getAnother

        public StringTokenIterator getAnother()
        Description copied from interface: UnfailingIterator
        Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator.
        Specified by:
        getAnother in interface SequenceIterator<StringValue>
        Specified by:
        getAnother in interface UnfailingIterator<StringValue>
        Returns:
        a new iterator over the same sequence