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 *      http://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
019/**
020 * Provides an implementation of an empty map iterator.
021 *
022 * @param <K> the type of keys
023 * @param <V> the type of mapped values
024 * @since 4.0
025 */
026public abstract class AbstractEmptyMapIterator<K, V> extends AbstractEmptyIterator<K> {
027
028    /**
029     * Create a new AbstractEmptyMapIterator.
030     */
031    public AbstractEmptyMapIterator() {
032    }
033
034    /**
035     * Always throws IllegalStateException.
036     *
037     * @return Always throws IllegalStateException.
038     * @throws IllegalStateException Always thrown.
039     */
040    public K getKey() {
041        throw new IllegalStateException("Iterator contains no elements");
042    }
043
044    /**
045     * Always throws IllegalStateException.
046     *
047     * @return Always throws IllegalStateException.
048     * @throws IllegalStateException Always thrown.
049     */
050    public V getValue() {
051        throw new IllegalStateException("Iterator contains no elements");
052    }
053
054    /**
055     * Always throws IllegalStateException.
056     *
057     * @param ignored ignored.
058     * @return Always throws IllegalStateException.
059     * @throws IllegalStateException Always thrown.
060     */
061    public V setValue(final V ignored) {
062        throw new IllegalStateException("Iterator contains no elements");
063    }
064
065}