Peeking Iterator

Problem

Given an Iterator class interface with methods: next() and hasNext(), design and implement a PeekingIterator that support the peek() operation -- it essentially peek() at the element that will be returned by the next call to next().

Here is an example. Assume that the iterator is initialized to the beginning of the list: [1, 2, 3].

Call next() gets you 1, the first element in the list.

Now you call peek() and it returns 2, the next element. Calling next() after that still return 2.

You call next() the final time and it returns 3, the last element. Calling hasNext() after that should return false.

Hint:

1. Think of "looking ahead". You want to cache the next element.
2. Is one variable sufficient? Why or why not?
3. Test your design with call order of peek() before next() vs next() before peek().
4. For a clean implementation, check out Google's guava library source code.

Follow up: How would you extend your design to be generic and work with all types, not just integer?

Solution

// Java Iterator interface reference:
// https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html
class PeekingIterator implements Iterator<Integer> {

    //This problem is given an iterator, we just need to adding a new feature "peek()"
    //We add a new filed "next" to accomplish that.

    private Integer next;
    private Iterator<Integer> itr;

    public PeekingIterator(Iterator<Integer> iterator) {
        // initialize any member here.
        this.itr = iterator;
        this.next = itr.hasNext() ? itr.next() : null;

    }

    // Returns the next element in the iteration without advancing the iterator.
    public Integer peek() {
        return this.next;
    }

    // hasNext() and next() should behave the same as in the Iterator interface.
    // Override them if needed.
    @Override
    public Integer next() {
        Integer res = this.next;
        this.next = itr.hasNext() ? itr.next() : null;    
        return res;  
    }

    @Override
    public boolean hasNext() {
        return this.next != null;
    }
}

Analisys

This problem is to improve the Java's Iterator by implementing peek() method. We create two files Integer next and Iterator<Integer> itr to accomplish it. Remember to make fully use of this.next while implementing all its method. Notice that calling itr.next() inside the class next() function won't cause overflow exception, they are different methods in different classes (this.itr != this).