using System;
using System.Runtime.Serialization;

namespace BLToolkit.Mapping
{
    /// <summary>
    /// Defines the base class for the namespace exceptions.
    /// </summary>
    /// <remarks>
    /// This class is the base class for exceptions that may occur during
    /// the execution of the <see cref="Map"/> class and other namespace members.
    /// </remarks>
    [Serializable] 
    public class MappingException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="MappingException"/> class.
        /// </summary>
        /// <remarks>
        /// This constructor initializes the <see cref="Exception.Message"/>
        /// property of the new instance 
        /// to a system-supplied message that describes the error, 
        /// such as "A Mapping exception has occurred."
        /// </remarks>
        public MappingException() 
            : base("A Mapping exception has occurred.")
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MappingException"/> class 
        /// with the specified error message.
        /// </summary>
        /// <param name="message">The message to display to the client when the
        /// exception is thrown.</param>
        /// <seealso cref="Exception.Message"/>
        public MappingException(string message) 
            : base(message) 
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MappingException"/> class 
        /// with the specified error message and InnerException property.
        /// </summary>
        /// <param name="message">The message to display to the client when the
        /// exception is thrown.</param>
        /// <param name="innerException">The InnerException, if any, that threw
        /// the current exception.</param>
        /// <seealso cref="Exception.Message"/>
        /// <seealso cref="Exception.InnerException"/>
        public MappingException(string message, Exception innerException) 
            : base(message, innerException) 
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MappingException"/> class 
        /// with the specified InnerException property.
        /// </summary>
        /// exception is thrown.</param>
        /// <param name="innerException">The InnerException, if any, that threw
        /// the current exception.</param>
        /// <seealso cref="Exception.InnerException"/>
        public MappingException(Exception innerException) 
            : base(innerException.Message, innerException) 
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MappingException"/> class
        /// with serialized data.
        /// </summary>
        /// <param name="info">The object that holds the serialized object data.</param>
        /// <param name="context">The contextual information about the source or
        /// destination.</param>
        /// <remarks>This constructor is called during deserialization to
        /// reconstitute the exception object transmitted over a stream.</remarks>
        protected MappingException(SerializationInfo info, StreamingContext context) 
            : base(info,context) 
        {
        }
    }
}