import { ICollection } from './collections';

/**
 * Interface for dictionary types.
 *
 * @export
 * @interface ISimpleDictionary
 * @extends {ICollection<[K, V]>}
 * @template K
 * @template V
 * @wInterface System.Collections.Generic.IDictionary`2
 * @wNetSupport
 */
export interface ISimpleDictionary<K, V> extends ICollection<[K, V]> {
  /**
   * The keys collection
   *
   * @type {ICollection<K>}
   * @memberof ISimpleDictionary
   * @wProperty Keys
   */
  readonly keys: ICollection<K>;

  /**
   * The values collection
   *
   * @type {ICollection<K>}
   * @memberof ISimpleDictionary
   * @wProperty Values
   */
  readonly values: ICollection<V>;

  getItem(key: K): V;
  setItem(key: K, value: V): void;

  /**
   * Add a entry to the dictionary
   *
   * @param {K} key
   * @param {V} value
   * @memberof ISimpleDictionary
   * @wMethod Add
   */
  addEntry(key: K, value: V);

  /**
   * Check if a key is contained in the dictionary
   *
   * @param {K} key
   * @param {V} value
   * @memberof ISimpleDictionary
   * @wMethod ContainsKey
   */
  hasKey(key: K);

  /**
   * Removes a entry to the dictionary
   *
   * @param {K} key
   * @param {V} value
   * @memberof ISimpleDictionary
   * @wMethod Remove
   */
  removeEntry(key: K);

  /**
   * Tries to get a value by key in the dictionary
   *
   * @param {K} key
   * @param {V} value
   * @memberof ISimpleDictionary
   * @wMethod TryGetValue
   * @wIgnore
   */
  tryGetValue(key: K, value: (v: V) => void);

  containsKey(key: K): boolean;
}