com.google.common.collect.ImmutableMapEntry Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2013 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.common.collect;

import static com.google.common.collect.CollectPreconditions.checkEntryNotNull;
import com.google.common.annotations.GwtIncompatible;
import javax.annotation.Nullable;

/**
 *  Implementation of {@code Map.Entry} for {@link ImmutableMap} that adds extra methods to traverse
 *  hash buckets for the key and the value. This allows reuse in {@link RegularImmutableMap} and
 *  {@link RegularImmutableBiMap}, which don't have to recopy the entries created by their
 *  {@code Builder} implementations.
 *
 *  @author Louis Wasserman
 *
 * @deprecated The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
 */
@GwtIncompatible("unnecessary")
@Deprecated(since = "2022-12-01")
abstract class ImmutableMapEntry extends ImmutableEntry {

    ImmutableMapEntry(K key, V value) {
        super(key, value);
        checkEntryNotNull(key, value);
    }

    ImmutableMapEntry(ImmutableMapEntry contents) {
        super(contents.getKey(), contents.getValue());
        // null check would be redundant
    }

    @Nullable
    abstract ImmutableMapEntry getNextInKeyBucket();

    @Nullable
    abstract ImmutableMapEntry getNextInValueBucket();

    // @deprecated The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
    @Deprecated(since = "2022-12-01")
    static final class TerminalEntry extends ImmutableMapEntry {

        TerminalEntry(ImmutableMapEntry contents) {
            super(contents);
        }

        TerminalEntry(K key, V value) {
            super(key, value);
        }

        @Override
        @Nullable
        ImmutableMapEntry getNextInKeyBucket() {
            return null;
        }

        @Override
        @Nullable
        ImmutableMapEntry getNextInValueBucket() {
            return null;
        }
    }
}