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

using System;

namespace RapidField.SolidInstruments.EventAuthoring
{
    /// <summary>
    /// Represents an exception that is raised by an <see cref="IReportable" /> instance while composing an <see cref="IEvent" />.
    /// </summary>
    public class EventAuthoringException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="EventAuthoringException" /> class.
        /// </summary>
        public EventAuthoringException()
            : this(eventType: null)
        {
            return;
        }

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

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

        /// <summary>
        /// Initializes a new instance of the <see cref="EventAuthoringException" />
        /// </summary>
        /// <param name="eventType">
        /// The type of the event that was being composed when the exception was raised.
        /// </param>
        /// <param name="innerException">
        /// The exception that is the cause of the current exception.
        /// </param>
        public EventAuthoringException(Type eventType, Exception innerException)
            : this(eventType is null ? "An exception was raised while composing an event." : $"An exception was raised while composing an event instance of type {eventType.FullName}.", innerException)
        {
            EventType = eventType;
        }

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

        /// <summary>
        /// Gets the type of the event that was being composed when the exception was raised.
        /// </summary>
        public Type EventType
        {
            get;
        }
    }
}