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

   1 //
   2 // XmlElementAttribute.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.Xml.Schema;
  32 using System;
  33
  34 namespace System.Xml.Serialization
  35 {
  36         /// <summary>
  37         /// Summary description for XmlElementAttribute.
  38         /// </summary
  39         [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field
  40                  | AttributeTargets.Parameter | AttributeTargets.ReturnValue, AllowMultiple=true)]
  41         public class XmlElementAttribute : Attribute
  42         {
  43                 private string dataType;
  44                 private string elementName;
  45                 private XmlSchemaForm form;
  46                 private string ns;
  47                 private bool isNullable, isNullableSpecified;
  48                 private Type type;
  49                 private int order = -1;
  50
  51                 public XmlElementAttribute ()
  52                 {
  53                 }
  54                 public XmlElementAttribute (string elementName)
  55                 {
  56                         this.elementName = elementName;
  57                 }
  58                 public XmlElementAttribute (Type type)
  59                 {
  60                         this.type = type;
  61                 }
  62                 public XmlElementAttribute (string elementName, Type type)
  63                 {
  64                         this.elementName = elementName;
  65                         this.type = type;
  66                 }
  67
  68                 public string DataType {
  69                         get {
  70                                 if (dataType == null) {
  71                                         return string.Empty;
  72                                 }
  73                                 return dataType;
  74                         }
  75                         set { dataType = value; }
  76                 }
  77
  78                 public string ElementName {
  79                         get {
  80                                 if (elementName == null) {
  81                                         return string.Empty;
  82                                 }
  83                                 return elementName;
  84                         }
  85                         set { elementName = value; }
  86                 }
  87
  88                 public XmlSchemaForm Form {
  89                         get {
  90                                 return form;
  91                         }
  92                         set {
  93                                 form = value;
  94                         }
  95                 }
  96
  97                 public string Namespace {
  98                         get {
  99                                 return ns;
 100                         }
 101                         set {
 102                                 ns = value;
 103                         }
 104                 }
 105
 106                 public bool IsNullable {
 107                         get {
 108                                 return isNullable;
 109                         }
 110                         set {
 111                                 isNullableSpecified = true;
 112                                 isNullable = value;
 113                         }
 114                 }
 115
 116                 internal bool IsNullableSpecified {
 117                         get { return isNullableSpecified; }
 118                 }
 119
 120                 public int Order {
 121                         get { return order; }
 122                         set { order = value; }
 123                 }
 124
 125                 public Type Type {
 126                         get {
 127                                 return type;
 128                         }
 129                         set {
 130                                 type = value;
 131                         }
 132                 }
 133
 134                 internal void AddKeyHash (System.Text.StringBuilder sb)
 135                 {
 136                         sb.Append ("XEA ");
 137                         KeyHelper.AddField (sb, 1, ns);
 138                         KeyHelper.AddField (sb, 2, elementName);
 139                         KeyHelper.AddField (sb, 3, form.ToString(), XmlSchemaForm.None.ToString());
 140                         KeyHelper.AddField (sb, 4, dataType);
 141                         KeyHelper.AddField (sb, 5, type);
 142                         KeyHelper.AddField (sb, 6, isNullable);
 143                         sb.Append ('|');
 144                 }
 145         }
 146 }