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 * https://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.OrderedMapIterator;
20
21 /**
22 * Provides an implementation of an empty ordered map iterator.
23 *
24 * @param <K> The type of keys
25 * @param <V> The type of mapped values
26 * @since 3.1
27 */
28 public class EmptyOrderedMapIterator<K, V> extends AbstractEmptyMapIterator<K, V>
29 implements OrderedMapIterator<K, V> {
30
31 /**
32 * Singleton instance of the iterator.
33 *
34 * @since 3.1
35 */
36 @SuppressWarnings("rawtypes")
37 public static final OrderedMapIterator INSTANCE = new EmptyOrderedMapIterator<>();
38
39 /**
40 * Gets a typed instance of the iterator.
41 *
42 * @param <K> The key type
43 * @param <V> The value type
44 * @return {@link OrderedMapIterator}<K, V>
45 */
46 public static <K, V> OrderedMapIterator<K, V> emptyOrderedMapIterator() {
47 return INSTANCE;
48 }
49
50 /**
51 * Constructs a new instance.
52 */
53 protected EmptyOrderedMapIterator() {
54 }
55
56 }