mcs/class/corlib/System/SerializableAttribute.cs

   1 //
   2 // System.SerializableAttribute.cs
   3 //
   4 // Author:
   5 //   Miguel de Icaza (miguel@ximian.com)
   6 //
   7 // (C) Ximian, Inc.  http://www.ximian.com
   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
  34 {
  35         /// <summary>
  36         ///   Serialization Attribute for classes.
  37         /// </summary>
  38
  39         /// <remarks>
  40         ///   Use SerializableAttribute to mark classes that do not implement
  41         ///   the ISerializable interface but that want to be serialized.
  42         ///
  43         ///   Failing to do so will cause the system to throw an exception.
  44         ///
  45         ///   When a class is market with the SerializableAttribute, all the
  46         ///   fields are automatically serialized with the exception of those
  47         ///   that are tagged with the NonSerializedAttribute.
  48         ///
  49         ///   SerializableAttribute should only be used for classes that contain
  50         ///   simple data types that can be serialized and deserialized by the
  51         ///   runtime (typically you would use NonSerializedAttribute on data
  52         ///   that can be reconstructed at any point: like caches or precomputed
  53         ///   tables).
  54         /// </remarks>
  55
  56         [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct
  57                 | AttributeTargets.Enum | AttributeTargets.Delegate,
  58                 Inherited=false, AllowMultiple=false)]
  59         public sealed class SerializableAttribute : Attribute
  60         {
  61         }
  62 }