Nuclex.Support/Source/Scheduling/AbortedException.cs

#region CPL License
/*
Nuclex Framework
Copyright (C) 2002-2009 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 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
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#endregion

using System;
using System.Collections.Generic;

namespace Nuclex.Support.Scheduling {

  /// <summary>Indicates that an operation has been forcefully aborted</summary>
  /// <remarks>
  ///   This exception is the typical result of using AsyncAbort() on a running
  ///   background process. 
  /// </remarks>
  [Serializable]
  public class AbortedException : Exception {

    /// <summary>Initializes the exception</summary>
    public AbortedException() { }

    /// <summary>Initializes the exception with an error message</summary>
    /// <param name="message">Error message describing the cause of the exception</param>
    public AbortedException(string message) : base(message) { }

    /// <summary>Initializes the exception as a followup exception</summary>
    /// <param name="message">Error message describing the cause of the exception</param>
    /// <param name="inner">Preceding exception that has caused this exception</param>
    public AbortedException(string message, Exception inner) : base(message, inner) { }

#if !COMPACTFRAMEWORK

    /// <summary>Initializes the exception from its serialized state</summary>
    /// <param name="info">Contains the serialized fields of the exception</param>
    /// <param name="context">Additional environmental informations</param>
    protected AbortedException(
      System.Runtime.Serialization.SerializationInfo info,
      System.Runtime.Serialization.StreamingContext context
    )
      : base(info, context) { }

#endif // !COMPACTFRAMEWORK

  }

} // namespace Nuclex.Support.Scheduling