solid-instruments/src/RapidField.SolidInstruments.Core/ArgumentEmptyException.cs at master · RapidField/solid-instruments · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
// =================================================================================================================================
// Copyright (c) RapidField LLC. Licensed under the MIT License. See LICENSE.txt in the project root for license information.
// =================================================================================================================================

using System;
using System.Diagnostics;

namespace RapidField.SolidInstruments.Core
{
    /// <summary>
    /// Represents an exception that is raised when an empty, non-null data reference is passed to a method that does not accept it
    /// as a valid argument.
    /// </summary>
    public sealed class ArgumentEmptyException : ArgumentException
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ArgumentEmptyException" /> class.
        /// </summary>
        public ArgumentEmptyException()
            : base(ConstructMessage(null))
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ArgumentEmptyException" /> class.
        /// </summary>
        /// <param name="parameterName">
        /// The name of the parameter that caused the exception.
        /// </param>
        public ArgumentEmptyException(String parameterName)
            : base(ConstructMessage(parameterName), parameterName, null)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ArgumentEmptyException" /> class.
        /// </summary>
        /// <param name="innerException">
        /// The exception that is the cause of the current exception.
        /// </param>
        public ArgumentEmptyException(Exception innerException)
            : base(ConstructMessage(null), null, innerException)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ArgumentEmptyException" /> class.
        /// </summary>
        /// <param name="message">
        /// The error message that explains the reason for the exception.
        /// </param>
        /// <param name="innerException">
        /// The exception that is the cause of the current exception.
        /// </param>
        public ArgumentEmptyException(String message, Exception innerException)
            : base(message, null, innerException)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ArgumentEmptyException" /> class.
        /// </summary>
        /// <param name="parameterName">
        /// The name of the parameter that caused the exception.
        /// </param>
        /// <param name="message">
        /// The error message that explains the reason for the exception.
        /// </param>
        public ArgumentEmptyException(String parameterName, String message)
            : base(message, parameterName, null)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ArgumentEmptyException" /> class.
        /// </summary>
        /// <param name="parameterName">
        /// The name of the parameter that caused the exception.
        /// </param>
        /// <param name="message">
        /// The error message that explains the reason for the exception.
        /// </param>
        /// <param name="innerException">
        /// The exception that is the cause of the current exception.
        /// </param>
        public ArgumentEmptyException(String parameterName, String message, Exception innerException)
            : base(message, parameterName, innerException)
        {
            return;
        }

        /// <summary>
        /// Constructs a message for the exception.
        /// </summary>
        /// <param name="parameterName">
        /// The name of the parameter which caused the current exception to be raised.
        /// </param>
        /// <returns>
        /// A generic message if <paramref name="parameterName" /> is null, otherwise a detailed message containing the provided
        /// value.
        /// </returns>
        [DebuggerHidden]
        private static String ConstructMessage(String parameterName) => parameterName is null ? "The specified argument is empty." : $"The {parameterName} argument is empty.";
    }
}