Mercurial > repos > IBBoard.WarFoundry.API

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* 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
comparison
equal deleted inserted replaced
336:3631c1493c7f 337:3c4a6403a88c
1 // This file (InvalidContainershipException.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard
2 //
3 // 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.
4
5 using System;
6 using IBBoard.Lang;
7
8 namespace IBBoard.WarFoundry.API.Objects
9 {
10 /// <summary>
11 /// 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
12 /// by that unit.
13 /// </summary>
14 public class InvalidContainershipException : Exception
15 {
16 private Unit containing;
17 private Unit contained;
18
19 public InvalidContainershipException(Unit containingUnit, Unit containedUnit) : base(CreateMessageString(containingUnit, containedUnit))
20 {
21 containing = containingUnit;
22 contained = containedUnit;
23 }
24
25 private static string CreateMessageString(Unit containingUnit, Unit containedUnit)
26 {
27 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);
28 }
29
30 /// <value>
31 /// The <see cref=" Unit"/> that the contained unit was added to
32 /// </value>
33 public Unit ContainingUnit
34 {
35 get { return containing; }
36 }
37
38 /// <value>
39 /// The <see cref=" Unit"/> that was added as a contained unit, but which was not of an allowed type
40 /// </value>
41 public Unit ContainedUnit
42 {
43 get { return contained; }
44 }
45 }
46 }