diff Limits/ILimit.cs @ 57:44bc5bd5c2f3

Re #24: Add limit objects * Create base interface * Create marker interface for percentage and numeric limits * Make classes implement appropriate interfaces
author IBBoard <dev@ibboard.co.uk>
date Sat, 24 Oct 2009 15:42:05 +0000
parents
children 90b9a3fe3c18
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Limits/ILimit.cs	Sat Oct 24 15:42:05 2009 +0000
@@ -0,0 +1,25 @@
+// This file (ILimit.cs) is a part of the IBBoard 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;
+
+namespace IBBoard.Limits
+{
+	/// <summary>
+	/// The interface for all limits
+	/// </summary>
+	public interface ILimit
+	{
+		/// <summary>
+		/// Gets the limited number, based on the limit that this <code>Limit</code> represents and the number it is limiting (<code>size</code>).
+		/// </summary>
+		/// <param name="size">
+		/// The number to be limited
+		/// </param>
+		/// <returns>
+		/// the limited number, as defined by the implementation of the limit
+		/// </returns>
+		int GetLimit(int size);
+	}
+}