View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.collections4.iterators;
18  
19  import java.util.Iterator;
20  
21  /**
22   * Provides basic behaviour for decorating an iterator with extra functionality.
23   * <p>
24   * All methods are forwarded to the decorated iterator.
25   *
26   * @since 3.0
27   */
28  public abstract class AbstractIteratorDecorator<E> extends AbstractUntypedIteratorDecorator<E, E> {
29  
30      //-----------------------------------------------------------------------
31      /**
32       * Constructor that decorates the specified iterator.
33       *
34       * @param iterator  the iterator to decorate, must not be null
35       * @throws NullPointerException if the iterator is null
36       */
37      protected AbstractIteratorDecorator(final Iterator<E> iterator) {
38          super(iterator);
39      }
40  
41      /** {@inheritDoc} */
42      @Override
43      public E next() {
44          return getIterator().next();
45      }
46  
47  }