diff API/Objects/InvalidContainershipException.cs @ 337:3c4a6403a88c

* Fix capitalisation so that new files are in the namespace no-open-ticket
author IBBoard <dev@ibboard.co.uk>
date Sun, 03 Apr 2011 18:50:32 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/API/Objects/InvalidContainershipException.cs	Sun Apr 03 18:50:32 2011 +0000
@@ -0,0 +1,46 @@
+//  This file (InvalidContainershipException.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard
+// 
+// The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.
+
+using System;
+using IBBoard.Lang;
+
+namespace IBBoard.WarFoundry.API.Objects
+{
+	/// <summary>
+	/// A custom exception for when a unit was added as a sub-unit of another unit, but was not of a <see cref=" UnitType"/> that can be contained
+	/// by that unit.
+	/// </summary>
+	public class InvalidContainershipException : Exception
+	{
+		private Unit containing;
+		private Unit contained;
+		
+		public InvalidContainershipException(Unit containingUnit, Unit containedUnit) : base(CreateMessageString(containingUnit, containedUnit))
+		{
+			containing = containingUnit;
+			contained = containedUnit;
+		}
+		
+		private static string CreateMessageString(Unit containingUnit, Unit containedUnit)
+		{
+			return String.Format("{0} cannot contain {1} because units of type {2} cannot contain units of type {3}", containingUnit.Name, containedUnit.Name, containingUnit.UnitType.Name, containedUnit.UnitType.Name);
+		}
+		
+		/// <value>
+		/// The <see cref=" Unit"/> that the contained unit was added to
+		/// </value>
+		public Unit ContainingUnit
+		{
+			get { return containing; }
+		}
+		
+		/// <value>
+		/// The <see cref=" Unit"/> that was added as a contained unit, but which was not of an allowed type
+		/// </value>
+		public Unit ContainedUnit
+		{
+			get { return contained; }
+		}
+	}
+}