using System;
using System.Runtime.Serialization;
using Chernobyl.Readiness;

namespace Chernobyl
{
    /// <summary>
    /// An exception that is thrown when a type, typically one that derives
    /// from <see cref="IReadyable"/>, cannot complete the action requested 
    /// because it is not ready (in other words, its 
    /// <see cref="IReadyable.IsReady"/> property is not set to true).
    /// </summary>
    public class NotReadyException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="NotReadyException"/> 
        /// class.
        /// </summary>
        public NotReadyException()
        { }

        /// <summary>
        /// Initializes a new instance of the <see cref="NotReadyException"/> 
        /// class.
        /// </summary>
        /// <param name="message">The error message that explains the reason for 
        /// the exception.</param>
        public NotReadyException(string message)
            : base(message)
        { }

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

        /// <summary>
        /// Initializes a new instance of the <see cref="NotReadyException"/> 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 NotReadyException(SerializationInfo info, StreamingContext context)
            : base(info, context)
        { }
    }
}