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

   1 //
   2 // System.Runtime.Serialization.IFormatter
   3 //
   4 // Author:
   5 //   David Dawkins (david@dawkins.st)
   6 //
   7 // (C) David Dawkins
   8 //
   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
  33 using System.IO;
  34
  35 namespace System.Runtime.Serialization {
  36
  37         /// <summary>
  38         /// Formatting for serialized objects</summary>
  39         [System.Runtime.InteropServices.ComVisibleAttribute (true)]
  40         public interface IFormatter {
  41
  42                 //
  43                 // Properties
  44                 //
  45
  46                 /// <summary>
  47                 /// Get or set the SerializationBinder used
  48                 /// for looking up types during deserialization</summary>
  49                 SerializationBinder Binder
  50                 {
  51                         get;
  52                         set;
  53                 }
  54
  55                 /// <summary>
  56                 /// Get or set the StreamingContext used for serialization
  57                 /// and deserialization</summary>
  58                 StreamingContext Context
  59                 {
  60                         get;
  61                         set;
  62                 }
  63
  64                 /// <summary>
  65                 /// Get or set the SurrogateSelector used by the current
  66                 /// formatter</summary>
  67                 ISurrogateSelector SurrogateSelector
  68                 {
  69                         get;
  70                         set;
  71                 }
  72
  73                 /// <summary>
  74                 /// Deserialize data from the specified stream, rebuilding
  75                 /// the object hierarchy</summary>
  76                 object Deserialize(
  77                         Stream serializationStream
  78                 );
  79
  80                 /// <summary>
  81                 /// Serialize the specified object to the specified stream.
  82                 /// Object may be the root of a graph of objects to be
  83                 /// serialized</summary>
  84                 void Serialize(
  85                         Stream serializationStream,
  86                         object graph
  87                 );
  88         }
  89
  90 }