// 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;

namespace TERASOLUNA.Fw.Common.Logging
{
    /// <summary>
    /// ログ処理の API を抽象化したシンプルなログ処理のインターフェイスです。
    /// </summary>
    /// <remarks>
    /// このインターフェイス実装したクラスには、 <see cref="LogFactory"/> によって
    /// 正しくインスタンス化を行えるようにするために、このログの「名前」を表す単独
    /// の String を引数として持つコンストラクタがなければなりません。 
    /// </remarks> 
    public interface ILog
    {
        /// <summary>
        /// Trace レベルのログ処理が現在有効かどうかチェックします。
        /// </summary>
        /// <remarks>
        /// ログレベルが trace 以上の場合に(String の連結のような) 
        /// 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。
        /// </remarks>
        bool IsTraceEnabled { get; }

        /// <summary>
        /// Debug レベルのログ処理が現在有効かどうかチェックします。
        /// </summary>
        /// <remarks>
        /// ログレベルが debug 以上の場合に(String の連結のような) 
        /// 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。
        /// </remarks>
        bool IsDebugEnabled { get; }

        /// <summary>
        /// Info レベルのログ処理が現在有効かどうかチェックします。
        /// </summary>
        /// <remarks>
        /// ログレベルが Info 以上の場合に(String の連結のような) 
        /// 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。
        /// </remarks>
        bool IsInfoEnabled { get; }

        /// <summary>
        /// Warn レベルのログ処理が現在有効かどうかチェックします。
        /// </summary>
        /// <remarks>
        /// ログレベルが Warn 以上の場合に(String の連結のような) 
        /// 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。
        /// </remarks>
        bool IsWarnEnabled { get; }

        /// <summary>
        /// Error レベルのログ処理が現在有効かどうかチェックします。
        /// </summary>
        /// <remarks>
        /// ログレベルが Error 以上の場合に(String の連結のような) 
        /// 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。
        /// </remarks>
        bool IsErrorEnabled { get; }

        /// <summary>
        /// Fatal レベルのログ処理が現在有効かどうかチェックします。
        /// </summary>
        /// <remarks>
        /// ログレベルが Fatal 以上の場合に(String の連結のような) 
        /// 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。
        /// </remarks>
        bool IsFatalEnabled { get; }

        /// <summary>
        /// Trace ログレベルでメッセージをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        void Trace(object message);

        /// <summary>
        /// Trace レベルでエラーをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        /// <param name="ex">ログ出力の原因となった例外。</param>
        void Trace(object message, Exception ex);

        /// <summary>
        /// Debug ログレベルでメッセージをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        void Debug(object message);

        /// <summary>
        /// Debug レベルでエラーをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        /// <param name="ex">ログ出力の原因となった例外。</param>
        void Debug(object message, Exception ex);

        /// <summary>
        /// Info ログレベルでメッセージをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        void Info(object message);

        /// <summary>
        /// Info レベルでエラーをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        /// <param name="ex">ログ出力の原因となった例外。</param>
        void Info(object message, Exception ex);

        /// <summary>
        /// Warn ログレベルでメッセージをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        void Warn(object message);

        /// <summary>
        /// Warn レベルでエラーをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        /// <param name="ex">ログ出力の原因となった例外。</param>
        void Warn(object message, Exception ex);

        /// <summary>
        /// Error ログレベルでメッセージをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        void Error(object message);

        /// <summary>
        /// Error レベルでエラーをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        /// <param name="ex">ログ出力の原因となった例外。</param>
        void Error(object message, Exception ex);

        /// <summary>
        /// Fatal ログレベルでメッセージをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        void Fatal(object message);

        /// <summary>
        /// Fatal レベルでエラーをログ出力します。
        /// </summary>
        /// <param name="message">ログ出力するメッセージ。</param>
        /// <param name="ex">ログ出力の原因となった例外。</param>
        void Fatal(object message, Exception ex);
    }
}
