view Limits/ILimit.cs @ 87:90b9a3fe3c18

* Correct licensing comments at top of files * Add an EqualityChecker class to handle null-safe equality checks no-open-ticket
author IBBoard <dev@ibboard.co.uk>
date Sat, 21 Aug 2010 10:04:52 +0000
parents 44bc5bd5c2f3
children
line wrap: on
line source

// 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 LGPL, 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);
	}
}