ExceptionInfo.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using System.Text;

namespace SiliconStudio.Core.Diagnostics
{
    /// <summary>
    /// This class is used to store some properties of an exception. It is serializable.
    /// </summary>
    [DataContract]
    public sealed class ExceptionInfo
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ExceptionInfo"/> class with default values for its properties
        /// </summary>
        public ExceptionInfo()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ExceptionInfo"/> class from an <see cref="Exception"/>.
        /// </summary>
        /// <param name="exception">The exception used to initialize the properties of this instance.</param>
        public ExceptionInfo(Exception exception)
        {
            if (exception == null) throw new ArgumentNullException("exception");
            Message = exception.Message;
            StackTrace = exception.StackTrace;
            TypeFullName = exception.GetType().FullName;
            TypeName = exception.GetType().Name;
            InnerException = exception.InnerException != null ? new ExceptionInfo(exception.InnerException) : null;
        }

        /// <summary>
        /// Gets or sets the message of the exception.
        /// </summary>
        public string Message { get; set; }

        /// <summary>
        /// Gets or sets the stack trace of the exception.
        /// </summary>
        public string StackTrace { get; set; }

        /// <summary>
        /// Gets or sets the full name of the exception type. Should correspond to the <see cref="Type.FullName"/> property of the exception type.
        /// </summary>
        public string TypeFullName { get; set; }

        /// <summary>
        /// Gets or sets the name of the exception type. Should correspond to the <see cref="Type.Name"/> property of the exception type.
        /// </summary>
        public string TypeName { get; set; }

        /// <summary>
        /// Gets or sets the <see cref="ExceptionInfo"/> of the inner exception.
        /// </summary>
        public ExceptionInfo InnerException { get; set; }

        /// <inheritdoc/>
        public override string ToString()
        {
            var sb = new StringBuilder();
            sb.AppendLine(Message);
            if (StackTrace != null)
                sb.AppendLine(StackTrace);
            if (InnerException != null)
                sb.AppendFormat("Inner exception: {0}{1}", InnerException, Environment.NewLine);
            return sb.ToString();
        }
    }
}