- /*
- * Copyright 2003-2004 The Apache Software Foundation
- *
- * 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 org.apache.commons.collections.iterators;
-
- import java.util.Iterator;
-
- /**
- * Provides basic behaviour for decorating an iterator with extra functionality.
- * <p>
- * All methods are forwarded to the decorated iterator.
- *
- * @since Commons Collections 3.0
- * @version $Revision: 1.4 $ $Date: 2004/02/18 00:59:50 $
- *
- * @author James Strachan
- * @author Stephen Colebourne
- */
- public class AbstractIteratorDecorator implements Iterator {
-
- /** The iterator being decorated */
- protected final Iterator iterator;
-
- //-----------------------------------------------------------------------
- /**
- * Constructor that decorates the specified iterator.
- *
- * @param iterator the iterator to decorate, must not be null
- * @throws IllegalArgumentException if the collection is null
- */
- public AbstractIteratorDecorator(Iterator iterator) {
- super();
- if (iterator == null) {
- throw new IllegalArgumentException("Iterator must not be null");
- }
- this.iterator = iterator;
- }
-
- /**
- * Gets the iterator being decorated.
- *
- * @return the decorated iterator
- */
- protected Iterator getIterator() {
- return iterator;
- }
-
- //-----------------------------------------------------------------------
- public boolean hasNext() {
- return iterator.hasNext();
- }
-
- public Object next() {
- return iterator.next();
- }
-
- public void remove() {
- iterator.remove();
- }
-
- }