// 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.Client.Communication
{
    /// <summary>
    /// 通信時にエラーが発生した場合にスローされる例外です。 
    /// </summary>
    [Serializable]
    public class CommunicationException : Exception
    {
        /// <summary>
        /// <see cref="CommunicationException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタです。
        /// </remarks>
        public CommunicationException()
            : base(Properties.Resources.E_COMMUNICATION_EXCEPTION)
        {
        }

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

        /// <summary>
        /// 指定したエラーメッセージと、この例外の原因である内部例外への参照を使用して、
        /// <see cref="CommunicationException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="message">エラーメッセージ。</param>
        /// <param name="innerException">現在の例外の原因である例外。</param>
        public CommunicationException(string message,
                                      Exception innerException)
            : base(message, innerException)
        {
        }

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