Formatter (Java 2 Platform SE 5.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Standard Ed. 5.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

java.util.logging
クラス Formatter

java.lang.Object
  java.util.logging.Formatter

直系の既知のサブクラス:: SimpleFormatter, XMLFormatter

public abstract class Formatter
extends Object
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 のメッセージフィールドが含まれます。Formatter.formatMessage の簡易メソッド (任意のオプション) を使用して、メッセージフィールドを地域対応にし、フォーマットすることができます。

パラメータ:: 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 スタイルのフォーマット処理を使用します。