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

   1 //
   2 // System.Runtime.Serialization.ISerializationSurrogate
   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 namespace System.Runtime.Serialization {
  34
  35         /// <summary>
  36         /// Interface for serialization surrogates</summary>
  37         [System.Runtime.InteropServices.ComVisibleAttribute (true)]
  38
  39         public interface ISerializationSurrogate {
  40
  41                 /// <summary>
  42                 /// Get the SerializationInfo necessary to serialize
  43                 /// the specified object </summary>
  44                 /// <param name="obj">Object to be serialized</param>
  45                 /// <param name="info">SerializationInfo to be populated</param>
  46                 /// <param name="context">Destination for serialization</param>
  47                 void GetObjectData(
  48                         object obj,
  49                         SerializationInfo info,
  50                         StreamingContext context
  51                 );
  52
  53                 /// <summary>
  54                 /// Populate an object using the specified SerializationInfo </summary>
  55                 /// <param name="obj">Object to be populated</param>
  56                 /// <param name="info">Data used for populating object</param>
  57                 /// <param name="context">Source for deserialization of object</param>
  58                 /// <param name="selector>Starting point for searching for compatible surrogates</param>
  59                 /// <returns>The deserialized object</returns>
  60                 object SetObjectData(
  61                         object obj,
  62                         SerializationInfo info,
  63                         StreamingContext context,
  64                         ISurrogateSelector selector
  65                 );
  66         }
  67
  68 }