using System;
using System.Runtime.Serialization;

namespace Chernobyl.Creation
{
    /// <summary>
    /// An exception that is thrown when an instance of a type or some other
    /// item could not be constructed.
    /// </summary>
    public class CreationException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="CreationException"/>.
        /// </summary>
        /// <param name="message">The error message that explains the reason for 
        /// the exception.</param>
        public CreationException(string message)
            : this(message, (Type)null)
        { }

        /// <summary>
        /// Initializes a new instance of the <see cref="CreationException"/> 
        /// class.
        /// </summary>
        /// <param name="message">The error message that explains the reason for 
        /// the exception.</param>
        /// <param name="failedCreatedType">The <see cref="Type"/> that could 
        /// not be constructed/configured or null if the 
        /// construction/configuration failure refers to another kind of item.</param>
        public CreationException(string message, Type failedCreatedType)
            : this(message, null, failedCreatedType)
        { }

        /// <summary>
        /// Initializes a new instance of the <see cref="CreationException"/> 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, or a null reference (Nothing in Visual Basic) if 
        /// no inner exception is specified.</param>
        public CreationException(string message, Exception innerException)
            : this(message, innerException, null)
        { }

        /// <summary>
        /// Initializes a new instance of the <see cref="CreationException"/> 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, or a null reference (Nothing in Visual Basic) if 
        /// no inner exception is specified.</param>
        /// <param name="failedCreatedType">The <see cref="Type"/> that could 
        /// not be constructed/configured or null if the 
        /// construction/configuration failure refers to another kind of item.</param>
        public CreationException(string message, Exception innerException, Type failedCreatedType)
            : base(message, innerException)
        {
            FailedCreatedType = failedCreatedType;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CreationException"/> class.
        /// </summary>
        /// <param name="info">The <see cref="SerializationInfo"/> that holds 
        /// the serialized object data about the exception being thrown.</param>
        /// <param name="context">The <see cref="StreamingContext"/> that contains 
        /// contextual information about the source or destination.</param>
        /// <exception cref="ArgumentNullException">The <paramref name="info"/> 
        /// parameter is null.</exception>
        /// <exception cref="SerializationException">The class name is null or 
        /// <see cref="Exception.HResult"/> is zero (0).</exception>
        public CreationException(SerializationInfo info, StreamingContext context)
            : base(info, context)
        { }

        /// <summary>
        /// The <see cref="Type"/> that could not be constructed/configured or 
        /// null if the construction/configuration failure refers to another 
        /// kind of item.
        /// </summary>
        public Type FailedCreatedType { get; set; }
    }
}