/AvalonEdit/ICSharpCode.AvalonEdit/Utils/ThrowUtil.cs

 1// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
 2// 
 3// Permission is hereby granted, free of charge, to any person obtaining a copy of this
 4// software and associated documentation files (the "Software"), to deal in the Software
 5// without restriction, including without limitation the rights to use, copy, modify, merge,
 6// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
 7// to whom the Software is furnished to do so, subject to the following conditions:
 8// 
 9// The above copyright notice and this permission notice shall be included in all copies or
10// substantial portions of the Software.
11// 
12// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
13// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
15// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
16// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
17// DEALINGS IN THE SOFTWARE.
18
19using System;
20using System.Globalization;
21
22namespace ICSharpCode.AvalonEdit.Utils
23{
24	/// <summary>
25	/// Contains exception-throwing helper methods.
26	/// </summary>
27	static class ThrowUtil
28	{
29		/// <summary>
30		/// Throws an ArgumentNullException if <paramref name="val"/> is null; otherwise
31		/// returns val.
32		/// </summary>
33		/// <example>
34		/// Use this method to throw an ArgumentNullException when using parameters for base
35		/// constructor calls.
36		/// <code>
37		/// public VisualLineText(string text) : base(ThrowUtil.CheckNotNull(text, "text").Length)
38		/// </code>
39		/// </example>
40		public static T CheckNotNull<T>(T val, string parameterName) where T : class
41		{
42			if (val == null)
43				throw new ArgumentNullException(parameterName);
44			return val;
45		}
46		
47		public static int CheckNotNegative(int val, string parameterName)
48		{
49			if (val < 0)
50				throw new ArgumentOutOfRangeException(parameterName, val, "value must not be negative");
51			return val;
52		}
53		
54		public static int CheckInRangeInclusive(int val, string parameterName, int lower, int upper)
55		{
56			if (val < lower || val > upper)
57				throw new ArgumentOutOfRangeException(parameterName, val, "Expected: " + lower.ToString(CultureInfo.InvariantCulture) + " <= " + parameterName + " <= " + upper.ToString(CultureInfo.InvariantCulture));
58			return val;
59		}
60		
61		public static InvalidOperationException NoDocumentAssigned()
62		{
63			return new InvalidOperationException("Document is null");
64		}
65		
66		public static InvalidOperationException NoValidCaretPosition()
67		{
68			return new InvalidOperationException("Could not find a valid caret position in the line");
69		}
70	}
71}