ImmutableElement.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Lachlan Dowding
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package permafrost.tundra.data;

/**
 * An immutable key value pair.
 *
 * @param <K>   The key's class.
 * @param <V>   The value's class.
 */
public class ImmutableElement<K, V> extends Element<K, V> {
    /**
     * Constructs a new element using the given key and value.
     *
     * @param key   The key for the element.
     * @param value The value for the element.
     */
    public ImmutableElement(K key, V value) {
        super(key, value);
    }

    /**
     * Not implemented, and always throws an UnsupportedOperationException.
     *
     * @param key                               The key to be set.
     * @return                                  The previous key of the element.
     * @throws UnsupportedOperationException    To ensure element is immutable, this exception is always thrown.
     */
    @Override
    public K setKey(K key) {
        throw new UnsupportedOperationException("setKey() not implemented");
    }

    /**
     * Not implemented, and always throws an UnsupportedOperationException.
     *
     * @param value                             The value to be set.
     * @return                                  The previous value of the element.
     * @throws UnsupportedOperationException    To ensure element is immutable, this exception is always thrown.
     */
    @Override
    public V setValue(V value) {
        throw new UnsupportedOperationException("setValue() not implemented");
    }
}