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 org.apache.commons.collections4.MapIterator;
20  
21  /**
22   * Provides basic behaviour for decorating a map iterator with extra functionality.
23   * <p>
24   * All methods are forwarded to the decorated map iterator.
25   *
26   * @param <K> the type of keys
27   * @param <V> the type of mapped values
28   * @since 3.0
29   */
30  public class AbstractMapIteratorDecorator<K, V> implements MapIterator<K, V> {
31  
32      /** The iterator being decorated */
33      private final MapIterator<K, V> iterator;
34  
35      //-----------------------------------------------------------------------
36      /**
37       * Constructor that decorates the specified iterator.
38       *
39       * @param iterator  the iterator to decorate, must not be null
40       * @throws NullPointerException if the iterator is null
41       */
42      public AbstractMapIteratorDecorator(final MapIterator<K, V> iterator) {
43          super();
44          if (iterator == null) {
45              throw new NullPointerException("MapIterator must not be null");
46          }
47          this.iterator = iterator;
48      }
49  
50      /**
51       * Gets the iterator being decorated.
52       *
53       * @return the decorated iterator
54       */
55      protected MapIterator<K, V> getMapIterator() {
56          return iterator;
57      }
58  
59      //-----------------------------------------------------------------------
60  
61      /** {@inheritDoc} */
62      @Override
63      public boolean hasNext() {
64          return iterator.hasNext();
65      }
66  
67      /** {@inheritDoc} */
68      @Override
69      public K next() {
70          return iterator.next();
71      }
72  
73      /** {@inheritDoc} */
74      @Override
75      public void remove() {
76          iterator.remove();
77      }
78  
79      /** {@inheritDoc} */
80      @Override
81      public K getKey() {
82          return iterator.getKey();
83      }
84  
85      /** {@inheritDoc} */
86      @Override
87      public V getValue() {
88          return iterator.getValue();
89      }
90  
91      /** {@inheritDoc} */
92      @Override
93      public V setValue(final V obj) {
94          return iterator.setValue(obj);
95      }
96  
97  }