org.eclipse.collections.impl.tuple.AbstractImmutableEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections Show documentation
There is a newer version: 12.0.0.M3
/*
 * Copyright (c) 2015 Goldman Sachs.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.impl.tuple;

import java.io.Serializable;
import java.util.Map;

import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.tuple.Pair;
import org.eclipse.collections.impl.block.factory.Functions;

public class AbstractImmutableEntry implements Map.Entry, Serializable
{
    private static final long serialVersionUID = 1L;
    private static final PairFunction TO_PAIR = new PairFunction();

    protected final K key;
    protected final V value;

    public AbstractImmutableEntry(K key, V value)
    {
        this.key = key;
        this.value = value;
    }

    /**
     * @deprecated Since 6.2 - Use {@link Functions#getKeyFunction()} instead.
     */
    @Deprecated
    public static  Function, K> getKeyFunction()
    {
        return Functions.getKeyFunction();
    }

    /**
     * @deprecated Since 6.2 - Use {@link Functions#getValueFunction()} instead.
     */
    @Deprecated
    public static  Function, V> getValueFunction()
    {
        return Functions.getValueFunction();
    }

    public static  Function, Pair> getPairFunction()
    {
        return (Function, Pair>) (Function) TO_PAIR;
    }

    public K getKey()
    {
        return this.key;
    }

    public V getValue()
    {
        return this.value;
    }

    /**
     * {@inheritDoc}
     * 
     * This implementation throws an {@link UnsupportedOperationException}. Override this method to support mutable
     * map entries.
     */
    public V setValue(V value)
    {
        throw new UnsupportedOperationException("Cannot call setValue() on " + this.getClass().getSimpleName());
    }

    /**
     * Returns a string representation of the form {@code {key}={value}}.
     */
    @Override
    public String toString()
    {
        return this.key + "=" + this.value;
    }

    /**
     * @deprecated Since 6.2 - Kept for serialization compatibility only.
     */
    @Deprecated
    private static class KeyFunction implements Function, K>
    {
        private static final long serialVersionUID = 1L;

        public K valueOf(Map.Entry entry)
        {
            return entry.getKey();
        }
    }

    /**
     * @deprecated Since 6.2 - Kept for serialization compatibility only.
     */
    @Deprecated
    private static class ValueFunction implements Function, V>
    {
        private static final long serialVersionUID = 1L;

        public V valueOf(Map.Entry entry)
        {
            return entry.getValue();
        }
    }

    private static class PairFunction implements Function, Pair>
    {
        private static final long serialVersionUID = 1L;

        public Pair valueOf(Map.Entry entry)
        {
            return Tuples.pairFrom(entry);
        }
    }
}