using System;
using System.Runtime.Serialization;

namespace Chernobyl.Resources
{
    /// <summary>
    /// An exception that is invoked when an <see cref="IResourceProcessor{TResource}"/> 
    /// is unable to pass along a resource request to its 
    /// <see cref="IResourceProcessor{TResource}.NextResourceProcessor"/> 
    /// because it does not exist.
    /// </summary>
    public class NoResourceProcessorException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the 
        /// <see cref="NoResourceProcessorException"/> class that uses a default 
        /// message specified by <see cref="DefaultMessage"/> as it its 
        /// <see cref="Exception.Message"/>.
        /// </summary>
        public NoResourceProcessorException() : base(DefaultMessage)
        {}

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

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

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

        /// <summary>
        /// The message that is used by default when the constructor with no 
        /// arguments is used.
        /// </summary>
        public const string DefaultMessage = "A resource could not be processed " +
                                             "because no IResourceProcessor<TResource> " + 
                                             "exists that can handle it.";
    }
}