#region Disclaimer / License
// Copyright (C) 2010, Jackie Ng
// http://trac.osgeo.org/mapguide/wiki/maestro, jumpinjackie@gmail.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
using System;
using System.Collections.Generic;
using System.Text;
namespace OSGeo.MapGuide.MaestroAPI
{
///
/// An exception thrown as a result of a failed precondition
///
[global::System.Serializable]
public class PreconditionException : Exception
{
//
// For guidelines regarding the creation of new exception types, see
// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconerrorraisinghandlingguidelines.asp
// and
// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dncscol/html/csharp07192001.asp
//
///
/// Initializes a new instance of the class.
///
public PreconditionException() { }
///
/// Initializes a new instance of the class.
///
/// The message.
public PreconditionException(string message) : base(message) { }
///
/// Initializes a new instance of the class.
///
/// The message.
/// The inner.
public PreconditionException(string message, Exception inner) : base(message, inner) { }
///
/// Initializes a new instance of the class.
///
/// The that holds the serialized object data about the exception being thrown.
/// The that contains contextual information about the source or destination.
///
/// The parameter is null.
///
///
/// The class name is null or is zero (0).
///
protected PreconditionException(
System.Runtime.Serialization.SerializationInfo info,
System.Runtime.Serialization.StreamingContext context)
: base(info, context) { }
}
///
/// Pre-condition verifier utility class
///
public static class Check
{
///
/// Check that condition evaluates to true
///
///
///
public static void That(bool condition, string msg)
{
if (!condition)
throw new PreconditionException(msg);
}
///
/// Check that value is not null
///
///
///
///
public static void NotNull(T obj, string arg) where T : class
{
if (obj == null)
throw new PreconditionException(Properties.Resources.PrecondValueNull + arg);
}
///
/// Check that string value is not null or empty
///
///
///
public static void NotEmpty(string value, string arg)
{
if (string.IsNullOrEmpty(value))
throw new PreconditionException(Properties.Resources.PrecondStringEmpty + arg);
}
///
/// Check that the specified condition is true
///
///
///
public static void Precondition(bool condition, string msg)
{
if (!condition)
throw new PreconditionException(Properties.Resources.PrecondFailure + msg);
}
}
}