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  /**
20   * Provides an implementation of an empty map iterator.
21   *
22   * @param <K> the type of keys
23   * @param <V> the type of mapped values
24   * @since 4.0
25   */
26  public abstract class AbstractEmptyMapIterator<K, V> extends AbstractEmptyIterator<K> {
27  
28      /**
29       * Create a new AbstractEmptyMapIterator.
30       */
31      public AbstractEmptyMapIterator() {
32      }
33  
34      /**
35       * Always throws IllegalStateException.
36       *
37       * @return Always throws IllegalStateException.
38       * @throws IllegalStateException Always thrown.
39       */
40      public K getKey() {
41          throw new IllegalStateException("Iterator contains no elements");
42      }
43  
44      /**
45       * Always throws IllegalStateException.
46       *
47       * @return Always throws IllegalStateException.
48       * @throws IllegalStateException Always thrown.
49       */
50      public V getValue() {
51          throw new IllegalStateException("Iterator contains no elements");
52      }
53  
54      /**
55       * Always throws IllegalStateException.
56       *
57       * @param ignored ignored.
58       * @return Always throws IllegalStateException.
59       * @throws IllegalStateException Always thrown.
60       */
61      public V setValue(final V ignored) {
62          throw new IllegalStateException("Iterator contains no elements");
63      }
64  
65  }