platform/util/src/com/intellij/util/keyFMap/KeyFMap.java

/*
 * Copyright 2000-2012 JetBrains s.r.o.
 *
 * 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.intellij.util.keyFMap;

import com.intellij.openapi.util.Key;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * An immutable map optimized for storing few {@link Key} entries with relatively rare updates
 * To construct a map, start with {@link KeyFMap#EMPTY_MAP} and call {@link #plus} and {@link #minus}
 *
 * @author peter
 */
public interface KeyFMap {
  KeyFMap EMPTY_MAP = new EmptyFMap();

  @NotNull
  <V> KeyFMap plus(@NotNull Key<V> key, @NotNull V value);
  @NotNull
  KeyFMap minus(@NotNull Key<?> key);

  @Nullable
  <V> V get(@NotNull Key<V> key);

  String toString();

  boolean isEmpty();
}