クラスFormatter

java.lang.Object
java.util.logging.Formatter
直系の既知のサブクラス:
SimpleFormatter, XMLFormatter
public abstract class Formatter extends Object
FormatterはLogRecordのフォーマット処理をサポートします。

通常、各ロギングHandlerにはFormatterが関連付けられます。 FormatterはLogRecordを受け取り、それを文字列に変換します。

XMLFormatterなどの一部のフォーマッタは、一連のフォーマット済みレコードの前後に先頭文字列と末尾文字列を付加する必要があります。 getHeaderおよびgetTailメソッドを使えば、これらの文字列を取得できます。

導入されたバージョン:
1.4

  • コンストラクタのサマリー

    コンストラクタ
    修飾子
    コンストラクタ
    説明
    protected
    Formatter()
    新しいフォーマッタを構築します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    abstract String
    format(LogRecord record)
    指定されたログ・レコードをフォーマットし、フォーマットされた文字列を返します。
    String
    formatMessage(LogRecord record)
    ログ・レコードからのメッセージ文字列をローカライズするようにフォーマットします。
    String
    getHead(Handler h)
    フォーマットされたレコードのセットのヘッダー文字列を返します。
    String
    getTail(Handler h)
    フォーマットされたレコード・セットの末尾の文字列を返します。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • コンストラクタの詳細

    • Formatter

      protected Formatter()
      新しいフォーマッタを構築します。

  • メソッドの詳細

    • format

      public abstract String format(LogRecord record)
      指定されたログ・レコードをフォーマットし、フォーマットされた文字列を返します。

      通常、フォーマットされたStringの結果には、ローカライズされ、フォーマットされたバージョンのLogRecordのメッセージ・フィールドが含まれます。 formatMessage(LogRecord)コンビニエンス・メソッドを使用して、メッセージ・フィールドをローカライズおよびフォーマットすることをお薦めします。

      パラメータ:
      record - フォーマットされるログ・レコード。
      戻り値:
      フォーマットされたログ・レコード

    • getHead

      public String getHead(Handler h)
      フォーマットされたレコードのセットのヘッダー文字列を返します。

      この基底クラスは空の文字列を返しますが、この処理はサブクラスによってオーバーライドされる場合があります。

      パラメータ:
      h - ターゲット・ハンドラ(nullも可能)
      戻り値:
      ヘッダー文字列

    • getTail

      public String getTail(Handler h)
      フォーマットされたレコード・セットの末尾の文字列を返します。

      この基底クラスは空の文字列を返しますが、この処理はサブクラスによってオーバーライドされる場合があります。

      パラメータ:
      h - ターゲット・ハンドラ(nullも可能)
      戻り値:
      末尾の文字列

    • formatMessage

      public String formatMessage(LogRecord record)
      ログ・レコードからのメッセージ文字列をローカライズするようにフォーマットします。 このメソッドは、Formatterのサブクラスがフォーマット処理を実行する際に使用可能な簡易手段として提供されています。

      メッセージ文字列は、レコードのResourceBundleを使用して、まずフォーマット文字列にローカライズされます。 (ResourceBundleが存在しない場合またはメッセージ・キーが見つからない場合は、そのキーがフォーマット文字列として使用されます。) フォーマットStringは、java.textスタイルのフォーマット処理を使用します。

      • パラメータがない場合、フォーマッタは使用されない
      • それ以外の場合、文字列に"{<digit>" (<digit>は[0-9])が含まれている場合は、文字列の書式設定にjava.text.MessageFormatが使用されます。
      • それ以外の場合は、フォーマット処理は実行されない

      パラメータ:
      record - rawメッセージを含むログ・レコード
      戻り値:
      ローカライズするようにフォーマットされたメッセージ