// Copyright (c) 2008, NTT DATA Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Runtime.Serialization;

namespace TERASOLUNA.Fw.Common
{
    /// <summary>
    /// FW共通の例外クラスです。
    /// </summary>
    /// <remarks>
    /// フレームワークで使用する例外クラスの基底クラスです。<br/>
    /// フレームワーク内で作成する例外は本クラスを継承する形で定義します。
    /// </remarks>
    [Serializable]
    public class TerasolunaException : Exception
    {
        /// <summary>
        /// <see cref="TerasolunaException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>デフォルトコンストラクタです。</remarks>
        public TerasolunaException()
        {
        }

        /// <summary>
        /// 指定したエラーメッセージを使用して、 <see cref="TerasolunaException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="message">エラーを説明するメッセージ。</param>
        /// <remarks>コンストラクタです。</remarks>
        public TerasolunaException(String message)
            : base(message)
        {
        }

        /// <summary>
        /// 指定したエラーメッセージと、この例外の原因である内部例外への参照を使用して、 
        /// <see cref="TerasolunaException"/> クラスの新しいインスタンスを初期化します。 
        /// </summary>
        /// <param name="message">
        /// 例外の原因を説明するエラーメッセージ。
        /// </param>
        /// <param name="inner">
        /// 現在の例外の原因である例外。
        /// inner パラメータが null 参照でない場合は、内部例外を処理する catch ブロックで現在の例外が発生します。
        /// </param>
        /// <remarks>コンストラクタです。</remarks>
        public TerasolunaException(String message, Exception inner)
            : base(message, inner)
        {
        }

        /// <summary>
        /// シリアル化したデータを使用して、 <see cref="TerasolunaException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="info">シリアル化されたオブジェクト データを保持するオブジェクト。</param>
        /// <param name="context">転送元または転送先に関するコンテキスト情報。</param>
        /// <remarks>デシリアライズされる際に呼び出されます。</remarks>
        protected TerasolunaException(SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
        }
    }
}