using System;
using System.Runtime.Serialization;

namespace Chernobyl.Input.Controls
{
    /// <summary>
    /// An exception that is thrown when the <see cref="IControl"/> that you
    /// attempting to perform an action on has been disconnected and can no
    /// longer be used.
    /// </summary>
    public class DisconnectedException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="DisconnectedException"/>
        /// class.
        /// </summary>
        /// <param name="control">The <see cref="IControl"/> that is disconnected.</param>
        /// <param name="message">The error message that explains the reason for
        /// the exception.</param>
        public DisconnectedException(IControl control, string message)
            : this(control, message, null)
        { }

        /// <summary>
        /// Initializes a new instance of the <see cref="DisconnectedException"/> class.
        /// </summary>
        /// <param name="control">The <see cref="IControl"/> that is disconnected.</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, or a null reference (Nothing in Visual Basic) if 
        /// no inner exception is specified.</param>
        public DisconnectedException(IControl control, string message, Exception innerException)
            : base(message, innerException)
        {
            Control = control;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="DisconnectedException"/> class.
        /// </summary>
        /// <param name="control">The <see cref="IControl"/> that is disconnected.</param>
        /// <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 DisconnectedException(IControl control, SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
            Control = control;
        }

        /// <summary>
        /// The <see cref="IControl"/> that is disconnected.
        /// </summary>
        public IControl Control { get; private set; }
    }
}