edu.ucla.sspace.text

Class BufferedIterator

java.lang.Object

edu.ucla.sspace.text.BufferedIterator

All Implemented Interfaces:

Iterator<String>

public class BufferedIterator
extends Object
implements Iterator<String>

An iterator over all the tokens in a stream, which supports arbitrary look-ahead into the stream by buffering the tokens.

Author:

David Jurgens

Constructor Summary

Constructors

Constructor and Description
BufferedIterator(BufferedReader br) Tokenizes the string contents on the reader and buffers to the tokens to allow arbitrary look-ahead.
BufferedIterator(Iterator<String> tokens) Buffers the tokens in the provided iterator to allow arbitrarily look-ahead.
BufferedIterator(String str) Tokenizes the string and buffers to the tokens to allow arbitrary look-ahead.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if the stream contains another token to return.
String	next() Returns the next token in the stream.
List<String>	peek(int tokens) Returns an list of the next tokens in the stream based on the requested amount.
void	remove() Throws an UnsupportedOperationException if called.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedIterator

public BufferedIterator(String str)

Tokenizes the string and buffers to the tokens to allow arbitrary look-ahead.

BufferedIterator

public BufferedIterator(BufferedReader br)

Tokenizes the string contents on the reader and buffers to the tokens to allow arbitrary look-ahead.

BufferedIterator

public BufferedIterator(Iterator<String> tokens)

Buffers the tokens in the provided iterator to allow arbitrarily look-ahead. The state of the provided iterator is updated by calls to this iterator.

Method Detail

hasNext

public boolean hasNext()

Returns true if the stream contains another token to return.

Specified by:

hasNext in interface Iterator<String>

next

public String next()

Returns the next token in the stream.

Specified by:

next in interface Iterator<String>

peek

public List<String> peek(int tokens)

Returns an list of the next tokens in the stream based on the requested amount. If the stream did not contain as many tokens as was requested, list will contain the remaining tokens, but will not throw an NoSuchElementException.

Parameters:

tokens - the number of tokens to access in the stream

Returns:

a list of the requested tokens or the remaining tokens in the stream, whichever is fewer

remove

public void remove()

Throws an UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<String>