001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4.iterators;
018
019import org.apache.commons.collections4.OrderedMapIterator;
020
021/**
022 * Provides an implementation of an empty ordered map iterator.
023 *
024 * @param <K> The type of keys
025 * @param <V> The type of mapped values
026 * @since 3.1
027 */
028public class EmptyOrderedMapIterator<K, V> extends AbstractEmptyMapIterator<K, V>
029        implements OrderedMapIterator<K, V> {
030
031    /**
032     * Singleton instance of the iterator.
033     *
034     * @since 3.1
035     */
036    @SuppressWarnings("rawtypes")
037    public static final OrderedMapIterator INSTANCE = new EmptyOrderedMapIterator<>();
038
039    /**
040     * Gets a typed instance of the iterator.
041     *
042     * @param <K> The key type
043     * @param <V> The value type
044     * @return {@link OrderedMapIterator}&lt;K, V&gt;
045     */
046    public static <K, V> OrderedMapIterator<K, V> emptyOrderedMapIterator() {
047        return INSTANCE;
048    }
049
050    /**
051     * Constructs a new instance.
052     */
053    protected EmptyOrderedMapIterator() {
054    }
055
056}