org.opengion.fukurou.util

## クラス LogSender

- java.lang.Object
- - org.opengion.fukurou.util.LogSender

-     public final class LogSender
      extends Object

  Logを書き込む為の LogWriter を呼び出す 簡易クラスです。 Log の書き込み日時や，キー(識別ID)などを出力します。
  機能分類
    エラー処理
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `static int` | `DEBUG` Log出力レベル DEBUG 0
    `static int` | `ERROR` Log出力レベル ERROR 3
    `static int` | `FATAL` Log出力レベル FATAL 4
    `static int` | `INFORMATION` Log出力レベル INFORMATION 1
    `static int` | `WARNING` Log出力レベル WARNING 2

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `LogSender()` デフォルトコンストラクター
    `LogSender(String userId)` ユーザーIDを与えてのコンストラクター ユーザーIDは，Logの識別IDとして使用します。
    `LogSender(String userId, int logLbl)` ユーザーIDと、ログレベルを与えてのコンストラクター ユーザーIDは，Logの識別IDとして使用します。

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `close()` LogWriter を明示的にclose() します。
    `void` | `debug(String message)` LogをLogWriter に渡します。
    `void` | `error(String message)` LogをLogWriter に渡します。
    `void` | `fatal(String message)` LogをLogWriter に渡します。
    `void` | `flush()` LogWriter を明示的にclose() します。
    `int` | `getLogLevel()` Logレベルを取得します。
    `void` | `info(String message)` LogをLogWriter に渡します。
    `void` | `setGuiId(String guiId)` 画面IDを設定します。
    `void` | `setMsgId(String msgId)` メッセージIDを設定します。
    `void` | `warn(String message)` LogをLogWriter に渡します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### FATAL

          public static final int FATAL

      Log出力レベル FATAL 4
      関連項目:
        定数フィールド値

    - #### ERROR

          public static final int ERROR

      Log出力レベル ERROR 3
      関連項目:
        定数フィールド値

    - #### WARNING

          public static final int WARNING

      Log出力レベル WARNING 2
      関連項目:
        定数フィールド値

    - #### INFORMATION

          public static final int INFORMATION

      Log出力レベル INFORMATION 1
      関連項目:
        定数フィールド値

    - #### DEBUG

          public static final int DEBUG

      Log出力レベル DEBUG 0
      関連項目:
        定数フィールド値

  - ### コンストラクタの詳細

    - #### LogSender

          public LogSender()

      デフォルトコンストラクター

    - #### LogSender

          public LogSender(String userId)

      ユーザーIDを与えてのコンストラクター ユーザーIDは，Logの識別IDとして使用します。
      パラメータ:
        `userId` - ユーザーID

    - #### LogSender

          public LogSender(String userId,
                   int logLbl)

      ユーザーIDと、ログレベルを与えてのコンストラクター ユーザーIDは，Logの識別IDとして使用します。 ログレベルは，0 ～ 4 の数字で、大きくなるほど、出力条件はきつくなります。 0:DEBUG, 1:INFORMATION, 2:WARNING, 3:ERROR, 4:FATAL 初期値は、3:ERROR です。
      パラメータ:
        `userId` - ユーザーID
        `logLbl` - ログレベル(0 ～ 4 の数字)

  - ### メソッドの詳細

    - #### setGuiId

          public void setGuiId(String guiId)

      画面IDを設定します。 ログ集計時の参考情報に使います。
      パラメータ:
        `guiId` - 画面ID

    - #### setMsgId

          public void setMsgId(String msgId)

      メッセージIDを設定します。 ログ集計時の参考情報に使います。
      パラメータ:
        `msgId` - メッセージID

    - #### getLogLevel

          public int getLogLevel()

      Logレベルを取得します。 ログレベルは, FATAL,ERROR,WARNING,INFORMATION,DEBUG から選べます。
      戻り値:
        Logレベル

    - #### debug

          public void debug(String message)

      LogをLogWriter に渡します。 DEBUG ログレベルと，あらかじめ設定されているLogレベルを 比較して, ログレベルが小さい場合は,出力しません。
      パラメータ:
        `message` - メッセージ

    - #### info

          public void info(String message)

      LogをLogWriter に渡します。 INFORMATION ログレベルと，あらかじめ設定されているLogレベルを 比較して, ログレベルが小さい場合は,出力しません。
      パラメータ:
        `message` - メッセージ

    - #### warn

          public void warn(String message)

      LogをLogWriter に渡します。 WARNING ログレベルと，あらかじめ設定されているLogレベルを 比較して, ログレベルが小さい場合は,出力しません。
      パラメータ:
        `message` - メッセージ

    - #### error

          public void error(String message)

      LogをLogWriter に渡します。 ERROR ログレベルと，あらかじめ設定されているLogレベルを 比較して, ログレベルが小さい場合は,出力しません。
      パラメータ:
        `message` - メッセージ

    - #### fatal

          public void fatal(String message)

      LogをLogWriter に渡します。 FATAL ログレベルと，あらかじめ設定されているLogレベルを 比較して, ログレベルが小さい場合は,出力しません。
      パラメータ:
        `message` - メッセージ

    - #### flush

          public void flush()

      LogWriter を明示的にclose() します。 LogWriter は，内部的に キャッシュを持っており,初めてアクセスされた場合に すでにオブジェクトが存在していれば,それを使い,無ければ 新たに追加モードで PrintWriter を作成します。 よって，明示的にclose()する必要性は ほとんど有りません。

    - #### close

          public void close()

      LogWriter を明示的にclose() します。 LogWriter は，内部的に キャッシュを持っており,初めてアクセスされた場合に すでにオブジェクトが存在していれば,それを使い,無ければ 新たに追加モードで PrintWriter を作成します。 よって，明示的にclose()する必要性は ほとんど有りません。

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.