mcs/class/System.XML/System.Xml.Serialization/XmlRootAttribute.cs

   1 //\r
   2 // XmlRootAttribute.cs: \r
   3 //\r
   4 // Author:\r
   5 //   John Donagher (john@webmeta.com)\r
   6 //\r
   7 // (C) 2002 John Donagher\r
   8 //\r
   9 \r
  10 //\r
  11 // Permission is hereby granted, free of charge, to any person obtaining\r
  12 // a copy of this software and associated documentation files (the\r
  13 // "Software"), to deal in the Software without restriction, including\r
  14 // without limitation the rights to use, copy, modify, merge, publish,\r
  15 // distribute, sublicense, and/or sell copies of the Software, and to\r
  16 // permit persons to whom the Software is furnished to do so, subject to\r
  17 // the following conditions:\r
  18 // \r
  19 // The above copyright notice and this permission notice shall be\r
  20 // included in all copies or substantial portions of the Software.\r
  21 // \r
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\r
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\r
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\r
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  29 //\r
  30 \r
  31 using System;\r
  32 \r
  33 namespace System.Xml.Serialization\r
  34 {\r
  35         /// <summary>\r
  36         /// Summary description for XmlRootAttribute.\r
  37         /// </summary>\r
  38         [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct |\r
  39                 AttributeTargets.Enum | AttributeTargets.Interface |\r
  40                 AttributeTargets.ReturnValue)]\r
  41         public class XmlRootAttribute : Attribute\r
  42         {\r
  43                 private string dataType;\r
  44                 private string elementName;\r
  45                 private bool isNullable = true;\r
  46                 private string ns;\r
  47 \r
  48                 public XmlRootAttribute ()\r
  49                 {\r
  50                 }\r
  51 \r
  52                 public XmlRootAttribute (string elementName)\r
  53                 {\r
  54                         this.elementName = elementName;\r
  55                 }\r
  56 \r
  57                 public string DataType {\r
  58                         get {\r
  59                                 if (dataType == null) {\r
  60                                         return string.Empty;\r
  61                                 }\r
  62                                 return dataType;\r
  63                         }\r
  64                         set { dataType = value; }\r
  65                 }\r
  66 \r
  67                 public string ElementName {\r
  68                         get {\r
  69                                 if (elementName == null) {\r
  70                                         return string.Empty;\r
  71                                 }\r
  72                                 return elementName;\r
  73                         }\r
  74                         set { elementName = value; }\r
  75                 }\r
  76 \r
  77                 public bool IsNullable {\r
  78                         get { return isNullable; }\r
  79                         set { isNullable = value; }\r
  80                 }\r
  81 \r
  82                 public string Namespace {\r
  83                         get { return ns; } \r
  84                         set { ns = value; }\r
  85                 }\r
  86                 \r
  87                 internal void AddKeyHash (System.Text.StringBuilder sb)\r
  88                 {\r
  89                         sb.Append ("XRA ");\r
  90                         KeyHelper.AddField (sb, 1, ns);\r
  91                         KeyHelper.AddField (sb, 2, elementName);\r
  92                         KeyHelper.AddField (sb, 3, dataType);\r
  93                         KeyHelper.AddField (sb, 4, isNullable);\r
  94                         sb.Append ('|');\r
  95                 }\r
  96         }\r
  97 }\r