mcs/class/Mono.CodeContracts/Mono.CodeContracts.Static.DataStructures/IImmutableMap.cs

   1 //
   2 // IImmutableMap.cs
   3 //
   4 // Authors:
   5 //      Alexander Chebaturkin (chebaturkin@gmail.com)
   6 //
   7 // Copyright (C) 2011 Alexander Chebaturkin
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Collections.Generic;
  31
  32 namespace Mono.CodeContracts.Static.DataStructures {
  33         interface IImmutableMap<K, V> {
  34                 V this [K key] { get; }
  35
  36                 K AnyKey { get; }
  37
  38                 IEnumerable<K> Keys { get; }
  39                 int Count { get; }
  40                 IImmutableMap<K, V> EmptyMap { get; }
  41
  42                 IImmutableMap<K, V> Add (K key, V value);
  43                 IImmutableMap<K, V> Remove (K key);
  44
  45                 bool ContainsKey (K key);
  46                 void Visit (Func<K, V, VisitStatus> func);
  47
  48             bool TryGetValue (K key, out V value);
  49
  50             IImmutableMapFactory<K, V> Factory();
  51         }
  52
  53     internal interface IImmutableMapFactory<K, V> {
  54         IImmutableMap<K, V> Empty { get; }
  55     }
  56 }