/*
 * Copyright (c) 2008 Harold Cooper. All rights reserved.
 * Licensed under the MIT License.
 * See LICENSE file in the project root for full license information.
 */

package org.pcollections;

import java.util.Collection;
import java.util.Map;

An immutable, persistent map from non-null keys of type K to non-null values of type V.
Author:
harold
Type parameters:
<K> – 
<V> – /**
 * An immutable, persistent map from non-null keys of type K to non-null values of type V.
 *
 * @author harold
 * @param <K>
 * @param <V>
 */
public interface PMap<K, V> extends Map<K, V> {
  
Params:
key – non-null
value – non-null
Returns:
a map with the mappings of this but with key mapped to value/**
   * @param key non-null
   * @param value non-null
   * @return a map with the mappings of this but with key mapped to value
   */
  public PMap<K, V> plus(K key, V value);

  
Params:
map – 
Returns:
this combined with map, with map's mappings used for any keys in both map and this/**
   * @param map
   * @return this combined with map, with map's mappings used for any keys in both map and this
   */
  public PMap<K, V> plusAll(Map<? extends K, ? extends V> map);

  
Params:
key – 
Returns:
a map with the mappings of this but with no value for key/**
   * @param key
   * @return a map with the mappings of this but with no value for key
   */
  public PMap<K, V> minus(Object key);

  
Params:
keys – 
Returns:
a map with the mappings of this but with no value for any element of keys/**
   * @param keys
   * @return a map with the mappings of this but with no value for any element of keys
   */
  public PMap<K, V> minusAll(Collection<?> keys);

  @Deprecated
  V put(K k, V v);

  @Deprecated
  V remove(Object k);

  @Deprecated
  void putAll(Map<? extends K, ? extends V> m);

  @Deprecated
  void clear();
}