001/*
002 * Copyright (C) 2010 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect;
018
019import com.google.common.annotations.GwtCompatible;
020import java.util.SortedMap;
021import org.checkerframework.checker.nullness.qual.Nullable;
022
023/**
024 * An object representing the differences between two sorted maps.
025 *
026 * @author Louis Wasserman
027 * @since 8.0
028 */
029@GwtCompatible
030@ElementTypesAreNonnullByDefault
031public interface SortedMapDifference<K extends @Nullable Object, V extends @Nullable Object>
032    extends MapDifference<K, V> {
033
034  @Override
035  SortedMap<K, V> entriesOnlyOnLeft();
036
037  @Override
038  SortedMap<K, V> entriesOnlyOnRight();
039
040  @Override
041  SortedMap<K, V> entriesInCommon();
042
043  @Override
044  SortedMap<K, ValueDifference<V>> entriesDiffering();
045}