SaveFileException.cs

/*
 * Idmr.Common.dll, Library file with common IDMR resources
 * Copyright (C) 2007-2014 Michael Gaisser (mjgaisser@gmail.com)
 * Licensed under the MPL v2.0 or later
 * 
 * Full notice in help/Idmr.Common.chm
 * Version: 1.3
 */

/* CHANGE LOG
 * v1.3, 141214
 * [UPD] switch to MPL
 * v1.1, XXXXXX
 * [NEW] _defaultMessage
 * [NEW] ctr(Exception)
 * [NEW] Serialization implementation
 * v1.0, XXXXXX
 * - Release
 */

using System;
using System.Runtime.Serialization;

namespace Idmr.Common
{
	/// <summary>Exception for file save failures, typically uses innerException.</summary>
	[Serializable]
	public class SaveFileException : Exception
	{
		static string _defaultMessage = "File could not be saved";
		
        /// <summary>Create a new exception with a default error message.</summary>
		/// <remarks>Default message is <b>"File could not be saved"</b>.</remarks>
        public SaveFileException()
			: base(_defaultMessage)
        {
        }
		/// <summary>Create a new exception with a specified error message.</summary>
		/// <param name="message">The specified error message.</param>
        public SaveFileException(string message)
            : base(message)
		{
		}
        /// <summary>Create a new exception with a specified error message and a reference to the initial exception.</summary>
        /// <param name="message">The specified error message.</param>
        /// <param name="innerEx">The initial exception.</param>
		public SaveFileException(string message, Exception innerEx)
            : base(message, innerEx)
		{
		}
		/// <summary>Create a new exception with a default error message and a reference to the initial exception.</summary>
		/// <param name="innerEx">The initial exception.</param>
		/// <remarks>Default message is <b>"File could not be saved"</b>.</remarks>
		public SaveFileException(Exception innerEx)
			: base(_defaultMessage + ": " + innerEx.Message, innerEx)
		{
		}

        /// <summary>Create a new exception using serialized data.</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>
        protected SaveFileException(SerializationInfo info, StreamingContext context)
            : base(info, context) { }
	}
}