org.apache.commons.logging
インタフェース Log

既知の実装クラスの一覧:
Jdk14Logger, Log4JCategoryLog, Log4JLogger, LogKitLogger, NoOpLog, SimpleLog

public interface Log

ログ処理の API を抽象化したシンプルなログ処理のインタフェースです。 このインタフェースを実装したクラスには、 LogFactory によって正しくインスタンス化を行えるようにするために、このログの「名前」を表す単独の String を引数として持つコンストラクタがなければなりません。

Log で使用される6つのログレベルは(順番に)以下のようになります。

  1. trace (最も軽微)
  2. debug
  3. info
  4. warn
  5. error
  6. fatal (最も重大)
これらのログレベルと内部で使用されるログシステムの概念とのマッピングは 各(ログシステム毎の)実装に依存します。 しかしながら各実装ではこの順序通りに動作することを保証する必要があります。

パフォーマンスはログ処理においてよく問題となる事柄です。 適宜プロパティを調べることによって、(ログに出力する情報の生成といった) 重い処理の部分を避けることができます。

[訳注: 文字列の生成や連結の事を指しているようです]

例えば、

    if (log.isDebugEnabled()) {
        ... (theResult を作成する)何か重い処理を実施 ...
        log.debug(theResult);
    }
 

内部で使用されるログシステムの設定は、そのシステムがどんなメカニズムをサポートしていたとしても、一般的に Logging API の外部で行われます。

バージョン:
$Id: Log.java,v 1.3 2004/04/08 12:22:29 hioki Exp $
作成者:
Scott Sanders, Rod Waldhoff
翻訳者:
日置 聡
校正者:
高橋 達男

メソッドの概要
 void debug(Object message)
           debug ログレベルでメッセージをログ出力します。
 void debug(Object message, Throwable t)
           debug レベルでエラーをログ出力します。
 void error(Object message)
           error レベルでメッセージをログ出力します。
 void error(Object message, Throwable t)
           error レベルでエラーをログ出力します。
 void fatal(Object message)
           fatal レベルでメッセージをログ出力します。
 void fatal(Object message, Throwable t)
           fatal レベルでエラーをログ出力します。
 void info(Object message)
           info レベルでメッセージをログ出力します。
 void info(Object message, Throwable t)
           info レベルでエラーをログ出力します。
 boolean isDebugEnabled()
           debug レベルのログ処理が現在有効かどうかチェックします。
 boolean isErrorEnabled()
           error レベルのログ処理が現在有効かどうかチェックします。
 boolean isFatalEnabled()
           fatal レベルのログ処理が現在有効かどうかチェックします。
 boolean isInfoEnabled()
           info レベルのログ処理が現在有効かどうかチェックします。
 boolean isTraceEnabled()
           trace レベルのログ処理が現在有効かどうかチェックします。
 boolean isWarnEnabled()
           warning レベルのログ処理が現在有効かどうかチェックします。
 void trace(Object message)
           trace レベルでメッセージをログ出力します。
 void trace(Object message, Throwable t)
           trace レベルでエラーをログ出力します。
 void warn(Object message)
           warn レベルでメッセージをログ出力します。
 void warn(Object message, Throwable t)
           warn レベルでエラーをログ出力します。
 

メソッドの詳細

isDebugEnabled

public boolean isDebugEnabled()

debug レベルのログ処理が現在有効かどうかチェックします。

ログレベルが debug 以上の場合に(String の連結のような) 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。


isErrorEnabled

public boolean isErrorEnabled()

error レベルのログ処理が現在有効かどうかチェックします。

ログレベルが error 以上の場合に(String の連結のような) 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。


isFatalEnabled

public boolean isFatalEnabled()

fatal レベルのログ処理が現在有効かどうかチェックします。

ログレベルが fatal 以上の場合に(String の連結のような) 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。


isInfoEnabled

public boolean isInfoEnabled()

info レベルのログ処理が現在有効かどうかチェックします。

ログレベルが info 以上の場合に(String の連結のような) 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。


isTraceEnabled

public boolean isTraceEnabled()

trace レベルのログ処理が現在有効かどうかチェックします。

ログレベルが trace 以上の場合に(String の連結のような) 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。


isWarnEnabled

public boolean isWarnEnabled()

warning レベルのログ処理が現在有効かどうかチェックします。

ログレベルが warning 以上の場合に(String の連結のような) 重い処理を行わないようにこのメソッドを呼んで(チェックして)ください。


trace

public void trace(Object message)

trace レベルでメッセージをログ出力します。

パラメータ:
message - このメッセージをログ出力します

trace

public void trace(Object message,
                  Throwable t)

trace レベルでエラーをログ出力します。

パラメータ:
message - このメッセージをログ出力します
t - この原因(となった例外)をログ出力します

debug

public void debug(Object message)

debug ログレベルでメッセージをログ出力します。

パラメータ:
message - このメッセージをログします

debug

public void debug(Object message,
                  Throwable t)

debug レベルでエラーをログ出力します。

パラメータ:
message - このメッセージをログ出力します
t - この原因(となった例外)をログ出力します

info

public void info(Object message)

info レベルでメッセージをログ出力します。

パラメータ:
message - このメッセージをログ出力します

info

public void info(Object message,
                 Throwable t)

info レベルでエラーをログ出力します。

パラメータ:
message - このメッセージをログ出力します
t - この原因(となった例外)をログ出力します

warn

public void warn(Object message)

warn レベルでメッセージをログ出力します。

パラメータ:
message - このメッセージをログ出力します

warn

public void warn(Object message,
                 Throwable t)

warn レベルでエラーをログ出力します。

パラメータ:
message - このメッセージをログ出力します
t - この原因(となった例外)をログ出力します

error

public void error(Object message)

error レベルでメッセージをログ出力します。

パラメータ:
message - このメッセージをログ出力します

error

public void error(Object message,
                  Throwable t)

error レベルでエラーをログ出力します。

パラメータ:
message - このメッセージをログ出力します
t - この原因(となった例外)をログ出力します

fatal

public void fatal(Object message)

fatal レベルでメッセージをログ出力します。

パラメータ:
message - このメッセージをログ出力します

fatal

public void fatal(Object message,
                  Throwable t)

fatal レベルでエラーをログ出力します。

パラメータ:
message - このメッセージをログ出力します
t - この原因(となった例外)をログ出力します


このドキュメントは、Ja-Jakartaにより訳されました。 コメントがある場合は report@jajakarta.orgまでお願いします。
Translated into Japanese by jajakarta.org. The original page is here.
Copyright (c) 2002-2003 - Apache Software Foundation