mcs/class/corlib/System.Runtime.Serialization/IFormatter.cs

   1 //\r
   2 // System.Runtime.Serialization.IFormatter\r
   3 //\r
   4 // Author:\r
   5 //   David Dawkins (david@dawkins.st)\r
   6 //\r
   7 // (C) David Dawkins\r
   8 //\r
   9
  10 //
  11 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32 \r
  33 using System.IO;\r
  34 \r
  35 namespace System.Runtime.Serialization {\r
  36 \r
  37         /// <summary>\r
  38         /// Formatting for serialized objects</summary>\r
  39         public interface IFormatter {\r
  40 \r
  41                 //\r
  42                 // Properties\r
  43                 //\r
  44 \r
  45                 /// <summary>\r
  46                 /// Get or set the SerializationBinder used\r
  47                 /// for looking up types during deserialization</summary>\r
  48                 SerializationBinder Binder \r
  49                 {\r
  50                         get; \r
  51                         set; \r
  52                 }\r
  53 \r
  54                 /// <summary>\r
  55                 /// Get or set the StreamingContext used for serialization\r
  56                 /// and deserialization</summary>\r
  57                 StreamingContext Context \r
  58                 { \r
  59                         get; \r
  60                         set; \r
  61                 }\r
  62 \r
  63                 /// <summary>\r
  64                 /// Get or set the SurrogateSelector used by the current\r
  65                 /// formatter</summary>\r
  66                 ISurrogateSelector SurrogateSelector \r
  67                 { \r
  68                         get; \r
  69                         set; \r
  70                 }\r
  71 \r
  72                 /// <summary>\r
  73                 /// Deserialize data from the specified stream, rebuilding\r
  74                 /// the object hierarchy</summary>\r
  75                 object Deserialize(\r
  76                         Stream serializationStream\r
  77                 );              \r
  78 \r
  79                 /// <summary>\r
  80                 /// Serialize the specified object to the specified stream.\r
  81                 /// Object may be the root of a graph of objects to be\r
  82                 /// serialized</summary>\r
  83                 void Serialize( \r
  84                         Stream serializationStream,\r
  85                         object graph\r
  86                 );\r
  87         }\r
  88 \r
  89 }\r