com.google.common.collect.ForwardingIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-collect Show documentation

Google Collections Library is a suite of new collections and collection-related goodness for Java 5.0

There is a newer version: snapshot-20080530

/*
 * Copyright (C) 2007 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.common.collect;

import java.util.Iterator;

/**
 * An iterator which forwards all its method calls to another iterator.
 * Subclasses should override one or more methods to modify the behavior of the
 * backing iterator as desired per the decorator pattern.
 * 
 * @see ForwardingObject
 * @author Kevin Bourrillion
 */
public abstract class ForwardingIterator extends ForwardingObject
    implements Iterator {

  /**
   * Constructs a forwarding iterator that forwards to the provided delegate.
   */
  protected ForwardingIterator(Iterator delegate) {
    super(delegate);
  }

  @SuppressWarnings("unchecked")
  @Override protected Iterator delegate() {
    return (Iterator) super.delegate();
  }

  public boolean hasNext() {
    return delegate().hasNext();
  }

  public T next() {
    return delegate().next();
  }

  public void remove() {
    delegate().remove();
  }
}