netcore/System.Private.CoreLib/shared/System/ArgumentException.cs

   1 // Licensed to the .NET Foundation under one or more agreements.
   2 // The .NET Foundation licenses this file to you under the MIT license.
   3 // See the LICENSE file in the project root for more information.
   4
   5 /*=============================================================================
   6 **
   7 **
   8 **
   9 ** Purpose: Exception class for invalid arguments to a method.
  10 **
  11 **
  12 =============================================================================*/
  13
  14 using System.Globalization;
  15 using System.Runtime.Serialization;
  16
  17 namespace System
  18 {
  19     // The ArgumentException is thrown when an argument does not meet
  20     // the contract of the method.  Ideally it should give a meaningful error
  21     // message describing what was wrong and which parameter is incorrect.
  22     [Serializable]
  23     [System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
  24     public class ArgumentException : SystemException
  25     {
  26         private readonly string? _paramName;
  27
  28         // Creates a new ArgumentException with its message
  29         // string set to the empty string.
  30         public ArgumentException()
  31             : base(SR.Arg_ArgumentException)
  32         {
  33             HResult = HResults.COR_E_ARGUMENT;
  34         }
  35
  36         // Creates a new ArgumentException with its message
  37         // string set to message.
  38         //
  39         public ArgumentException(string? message)
  40             : base(message)
  41         {
  42             HResult = HResults.COR_E_ARGUMENT;
  43         }
  44
  45         public ArgumentException(string? message, Exception? innerException)
  46             : base(message, innerException)
  47         {
  48             HResult = HResults.COR_E_ARGUMENT;
  49         }
  50
  51         public ArgumentException(string? message, string? paramName, Exception? innerException)
  52             : base(message, innerException)
  53         {
  54             _paramName = paramName;
  55             HResult = HResults.COR_E_ARGUMENT;
  56         }
  57
  58         public ArgumentException(string? message, string? paramName)
  59             : base(message)
  60         {
  61             _paramName = paramName;
  62             HResult = HResults.COR_E_ARGUMENT;
  63         }
  64
  65         protected ArgumentException(SerializationInfo info, StreamingContext context)
  66             : base(info, context)
  67         {
  68             _paramName = info.GetString("ParamName");
  69         }
  70
  71         public override void GetObjectData(SerializationInfo info, StreamingContext context)
  72         {
  73             base.GetObjectData(info, context);
  74             info.AddValue("ParamName", _paramName, typeof(string));
  75         }
  76
  77         public override string Message
  78         {
  79             get
  80             {
  81                 SetMessageField();
  82
  83                 string s = base.Message;
  84                 if (!string.IsNullOrEmpty(_paramName))
  85                 {
  86                     s += " " + SR.Format(SR.Arg_ParamName_Name, _paramName);
  87                 }
  88
  89                 return s;
  90             }
  91         }
  92
  93         private void SetMessageField()
  94         {
  95             if (_message == null && HResult == System.HResults.COR_E_ARGUMENT)
  96             {
  97                 _message = SR.Arg_ArgumentException;
  98             }
  99         }
 100
 101         public virtual string? ParamName => _paramName;
 102     }
 103 }