solid-instruments/src/RapidField.SolidInstruments.Core/UnsupportedSpecificationException.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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// =================================================================================================================================
// Copyright (c) RapidField LLC. Licensed under the MIT License. See LICENSE.txt in the project root for license information.
// =================================================================================================================================

using RapidField.SolidInstruments.Core.Extensions;
using System;
using System.Diagnostics;

namespace RapidField.SolidInstruments.Core
{
    /// <summary>
    /// Represents an exception that is raised when a method or type is supplied with unsupported or unrecognized specification(s).
    /// </summary>
    public sealed class UnsupportedSpecificationException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="UnsupportedSpecificationException" /> class.
        /// </summary>
        public UnsupportedSpecificationException()
            : this(unsupportedSpecification: null)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="UnsupportedSpecificationException" /> class.
        /// </summary>
        /// <param name="unsupportedSpecification">
        /// The unsupported specification(s) that caused the exception.
        /// </param>
        public UnsupportedSpecificationException(Object unsupportedSpecification)
            : this(unsupportedSpecification, null, null)
        {
            return;
        }

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

        /// <summary>
        /// Initializes a new instance of the <see cref="UnsupportedSpecificationException" /> 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 UnsupportedSpecificationException(String message, Exception innerException)
            : this(unsupportedSpecification: null, message: message, innerException: innerException)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="UnsupportedSpecificationException" /> class.
        /// </summary>
        /// <param name="unsupportedSpecification">
        /// The unsupported specification(s) that caused the exception.
        /// </param>
        /// <param name="innerException">
        /// The exception that is the cause of the current exception.
        /// </param>
        public UnsupportedSpecificationException(Object unsupportedSpecification, Exception innerException)
            : this(unsupportedSpecification, null, innerException)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="UnsupportedSpecificationException" /> class.
        /// </summary>
        /// <param name="unsupportedSpecification">
        /// The unsupported specification(s) 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 UnsupportedSpecificationException(Object unsupportedSpecification, String message, Exception innerException)
            : base(message.IsNullOrEmpty() ? ConstructMessage(unsupportedSpecification) : message, innerException)
        {
            UnsupportedSpecification = unsupportedSpecification;
        }

        /// <summary>
        /// Constructs a message for the exception.
        /// </summary>
        /// <param name="unsupportedSpecification">
        /// The unsupported specification(s) that caused the exception.
        /// </param>
        /// <returns>
        /// A message for the exception.
        /// </returns>
        [DebuggerHidden]
        private static String ConstructMessage(Object unsupportedSpecification)
        {
            if (unsupportedSpecification is null)
            {
                return "The supplied specification(s) are not supported.";
            }

            return $"The supplied specification(s) are not supported: {unsupportedSpecification}.";
        }

        /// <summary>
        /// Gets the unsupported specification(s) that caused the current exception to be raised.
        /// </summary>
        public Object UnsupportedSpecification
        {
            get;
        }
    }
}