solid-instruments/src/RapidField.SolidInstruments.Command/CommandHandlingException.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
// =================================================================================================================================
// Copyright (c) RapidField LLC. Licensed under the MIT License. See LICENSE.txt in the project root for license information.
// =================================================================================================================================

using System;

namespace RapidField.SolidInstruments.Command
{
    /// <summary>
    /// Represents an exception that is raised by an <see cref="ICommandHandler{TCommand}" /> instance while processing a
    /// <see cref="ICommand" />.
    /// </summary>
    public class CommandHandlingException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="CommandHandlingException" /> class.
        /// </summary>
        public CommandHandlingException()
            : this(commandType: null)
        {
            return;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CommandHandlingException" />
        /// </summary>
        /// <param name="commandType">
        /// The type of the command that was being processed when the exception was raised.
        /// </param>
        public CommandHandlingException(Type commandType)
            : this(commandType: commandType, innerException: null)
        {
            return;
        }

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

        /// <summary>
        /// Initializes a new instance of the <see cref="CommandHandlingException" />
        /// </summary>
        /// <param name="commandType">
        /// The type of the command that was being processed when the exception was raised.
        /// </param>
        /// <param name="innerException">
        /// The exception that is the cause of the current exception.
        /// </param>
        public CommandHandlingException(Type commandType, Exception innerException)
            : this(commandType is null ? "An exception was raised while processing a command." : $"An exception was raised while processing a command instance of type {commandType.FullName}.", innerException)
        {
            CommandType = commandType;
        }

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

        /// <summary>
        /// Gets the type of the command that was being processed when the exception was raised.
        /// </summary>
        public Type CommandType
        {
            get;
        }
    }
}