mcs/class/corlib/System/IConvertible.cs

   1 //
   2 // System.IConvertible.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 //
  34 // Functions Implementing this interface should check out
  35 // System.Convert. Most of these methods are implemented
  36 // there for all these data types.
  37 //
  38 // System.Convert has ToType helper method for the object
  39 // ToType (Type conversionType, IFormatProvider provider)
  40 // method. In most cases you can specify your ToType function
  41 // as calling
  42 //
  43 // public Type value; // value of this data type
  44 // public object ToType(Type conversionType, IFormatProvider provider) {
  45 //    Convert.ToType (value, conversionType, provider);
  46 // }
  47 //
  48 // Which is just a wrapper for your ToType methods.
  49 //
  50 // See http://lists.ximian.com/archives/public/mono-list/2001-July/000525.html
  51 // for more discussion on the topic
  52 //
  53 using System.Runtime.InteropServices;
  54
  55 namespace System {
  56
  57     [ComVisible(true)]
  58     [CLSCompliant(false)]
  59     public interface IConvertible {
  60
  61         TypeCode GetTypeCode ();
  62
  63         bool     ToBoolean  (IFormatProvider provider);
  64         byte     ToByte     (IFormatProvider provider);
  65         char     ToChar     (IFormatProvider provider);
  66         DateTime ToDateTime (IFormatProvider provider);
  67         decimal  ToDecimal  (IFormatProvider provider);
  68         double   ToDouble   (IFormatProvider provider);
  69         short    ToInt16    (IFormatProvider provider);
  70         int      ToInt32    (IFormatProvider provider);
  71         long     ToInt64    (IFormatProvider provider);
  72         sbyte    ToSByte    (IFormatProvider provider);
  73         float    ToSingle   (IFormatProvider provider);
  74         string   ToString   (IFormatProvider provider);
  75         object   ToType     (Type conversionType, IFormatProvider provider);
  76         ushort   ToUInt16   (IFormatProvider provider);
  77         uint     ToUInt32   (IFormatProvider provider);
  78         ulong    ToUInt64   (IFormatProvider provider);
  79     }
  80 }