java.util.logging

クラス 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) フォーマットされたレコードセットの末尾の文字列を返します。

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

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

コンストラクタの詳細

Formatter

protected Formatter()

新しいフォーマッタを構築します。

メソッドの詳細

format

public abstract String format(LogRecord record)

指定されたログレコードをフォーマットし、フォーマットされた文字列を返します。

通常、フォーマットされた String の結果には、ローカライズされ、フォーマットされたバージョンの LogRecord のメッセージフィールドが含まれます。メッセージフィールドをローカライズし、フォーマットするには、formatMessage(java.util.logging.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 スタイルのフォーマット処理を使用します。

• パラメータがない場合、フォーマッタは使用されない
• パラメータがあり、文字列に "{0" の次に java.text.MessageFormat が含まれる場合は、フォーマッタは文字列のフォーマットに使われる
• それ以外の場合は、フォーマット処理は実行されない

パラメータ:

record - raw メッセージを含むログレコード

戻り値:

ローカライズするようにフォーマットされたメッセージ