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

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