java.util.logging
クラス LogRecord

java.lang.Object
  java.util.logging.LogRecord

すべての実装されたインタフェース:

Serializable

public class LogRecord
extends Object
implements Serializable

LogRecord オブジェクトを使用して、ログのフレームワークと個々のログ Handler 間のロギングの要求を渡します。

LogRecord がログのフレームワークに渡されると、LogRecord は論理的にそのフレームワークに所属します。クライアントアプリケーションが使用したり、更新してはいけません。

クライアントアプリケーションが明示的なソースメソッド名とソースクラス名を指定しなかった場合、LogRecord クラスは、getSourceMethodName または getSourceClassName 呼び出し経由でそれらの名前が初めてアクセスされた時点で、呼び出しスタックを分析することでそれらの名前を自動的に推測することに注意してください。したがって、ロギング Handler は、LogRecord を別のスレッドに渡したり RMI 経由で送信したりしたあとでメソッド名やクラス名の情報を取得できるようにしたい場合は、getSourceClassName、getSourceMethodName のいずれかを呼び出すことで、値が強制的に設定されるようにすべきです。

直列化に関する注意:

• LogRecord クラスは直列化可能である
• パラメータ配列のオブジェクトは直列化できないので、直列化時にパラメータ配列のすべてのオブジェクトは Object.toString を使用して対応する String として書き込まれる
• ResourceBundle は直列化された形式の一部として転送されないが、リソ-スバンドル名は転送され、受け側のオブジェクトの readObject メソッドは適切なリソースバンドルを検出しようとする

導入されたバージョン:

1.4

関連項目:

直列化された形式

コンストラクタの概要

LogRecord(Level level, String msg)
指定されたレベルとメッセージの値を持つ LogRecord を構築します。

メソッドの概要

Level	getLevel() ログメッセージレベル、たとえば Level.SEVERE を返します。
String	getLoggerName() ソース Logger の名前を返します。
String	getMessage() 地域化またはフォーマット処理の前に、未変換のログメッセージを返します。
long	getMillis() 1970 年以降のイベントの時間を返します (ミリ秒単位)。
Object[]	getParameters() ログメッセージにパラメータを返します。
ResourceBundle	getResourceBundle() ローカリゼーションリソースバンドルを返します。
String	getResourceBundleName() ローカリゼーションリソースバンドルの名前を返します。
long	getSequenceNumber() シーケンス番号を返します。
String	getSourceClassName() ロギングの要求を発行したか、発行したと見なされるクラスの名前を返します。
String	getSourceMethodName() ロギングの要求を発行したか、発行したと見なされるクラスの名前を返します。
int	getThreadID() メッセージの発生元のスレッドの識別子を返します。
Throwable	getThrown() ログレコードに関連した Throwable を返します。
void	setLevel(Level level) ログメッセージのレベル、たとえば Level.SEVERE を設定します。
void	setLoggerName(String name) ソース Logger の名前を設定します。
void	setMessage(String message) 地域化またはフォーマット処理の前に、未変換のログメッセージを設定します。
void	setMillis(long millis) イベントの時間を設定します。
void	setParameters(Object[] parameters) ログメッセージにパラメータを設定します。
void	setResourceBundle(ResourceBundle bundle) ローカリゼーションリソースバンドルを設定します。
void	setResourceBundleName(String name) ローカリゼーションリソースバンドルの名前を設定します。
void	setSequenceNumber(long seq) シーケンス番号を設定します。
void	setSourceClassName(String sourceClassName) ロギングの要求を発行したか、発行したと見なされるクラスの名前を設定します。
void	setSourceMethodName(String sourceMethodName) ロギングの要求を発行したか、発行したと見なされるメソッドの名前を設定します。
void	setThreadID(int threadID) メッセージの発生元のスレッドの識別子を設定します。
void	setThrown(Throwable thrown) ログイベントに関連した Throwable を設定します。

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

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

コンストラクタの詳細

LogRecord

public LogRecord(Level level,
                 String msg)

指定されたレベルとメッセージの値を持つ LogRecord を構築します。

sequence プロパティーは新しい一意の値で初期化されます。これらの連番値は、VM 内で昇順に割り当てられます。

millis プロパティーは、現在の時刻に初期化されます。

スレッド ID プロパティーは現在のスレッドに対する一意の ID で初期化されます。

その他すべてのプロパティーは null に初期化されます。

パラメータ:

level - ログレベルの値

msg - ローカライズされていない raw ログメッセージ (null も可能)

メソッドの詳細

getLoggerName

public String getLoggerName()

ソース Logger の名前を返します。

戻り値:

ソースロガー名 (null の場合がある)

setLoggerName

public void setLoggerName(String name)

ソース Logger の名前を設定します。

パラメータ:

name - ソースロガー名 (null の場合がある)

getResourceBundle

public ResourceBundle getResourceBundle()

ローカリゼーションリソースバンドルを返します。

これは、メッセージ文字列のフォーマット前にその文字列をローカライズするのに使用すべき ResourceBundle です。メッセージがローカライズ可能でない場合、または適切な ResourceBundle が使用可能でない場合は、結果が null になります。

setResourceBundle

public void setResourceBundle(ResourceBundle bundle)

ローカリゼーションリソースバンドルを設定します。

パラメータ:

bundle - ローカリゼーションバンドル (null の場合がある)

getResourceBundleName

public String getResourceBundleName()

ローカリゼーションリソースバンドルの名前を返します。

これは、メッセージ文字列のフォーマット前にその文字列をローカライズするのに使用すべき ResourceBundle の名前です。メッセージがローカライズ可能でない場合は、結果が null になります。

setResourceBundleName

public void setResourceBundleName(String name)

ローカリゼーションリソースバンドルの名前を設定します。

パラメータ:

name - ローカリゼーションバンドルの名前 (null の場合がある)

getLevel

public Level getLevel()

ログメッセージレベル、たとえば Level.SEVERE を返します。

戻り値:

ログメッセージのレベル

setLevel

public void setLevel(Level level)

ログメッセージのレベル、たとえば Level.SEVERE を設定します。

パラメータ:

level - ログメッセージのレベル

getSequenceNumber

public long getSequenceNumber()

シーケンス番号を返します。

通常、シーケンス番号は LogRecord コンストラクタに割り当てられ、コンストラクタは新規の各 LogRecord に昇順で一意のシーケンス番号を割り当てます。

戻り値:

シーケンス番号

setSequenceNumber

public void setSequenceNumber(long seq)

シーケンス番号を設定します。

通常、シーケンス番号は LogRecord コンストラクタに割り当てられます。したがって、通常このメソッドを使用する必要がありません。

getSourceClassName

public String getSourceClassName()

ロギングの要求を発行したか、発行したと見なされるクラスの名前を返します。

この sourceClassName は検証されないため、スプーフィングされる可能性があることに注意してください。この情報は、ロギング呼び出しの一部として提供されたか、ロギングフレームワークによって自動的に推測されたものです。後者の場合、この情報は概算値でしかなく、実際、スタックフレーム上の以前の呼び出しを記述したものである可能性があります。

情報が取得されない場合は null の場合があります。

戻り値:

ソースクラスの名前

setSourceClassName

public void setSourceClassName(String sourceClassName)

ロギングの要求を発行したか、発行したと見なされるクラスの名前を設定します。

パラメータ:

sourceClassName - ソースクラス名 (null の場合がある)

getSourceMethodName

public String getSourceMethodName()

ロギングの要求を発行したか、発行したと見なされるクラスの名前を返します。

この sourceClassName は検証されないため、スプーフィングされる可能性があることに注意してください。この情報は、ロギング呼び出しの一部として提供されたか、ロギングフレームワークによって自動的に推測されたものです。後者の場合、この情報は概算値でしかなく、実際、スタックフレーム上の以前の呼び出しを記述したものである可能性があります。

情報が取得されない場合は null の場合があります。

戻り値:

ソースメソッドの名前

setSourceMethodName

public void setSourceMethodName(String sourceMethodName)

ロギングの要求を発行したか、発行したと見なされるメソッドの名前を設定します。

パラメータ:

sourceMethodName - ソースメソッド名 (null の場合がある)

getMessage

public String getMessage()

地域化またはフォーマット処理の前に、未変換のログメッセージを返します。

null の場合があり、これは空の文字列 "" と同等です。

このメッセージは、ファイナルテキストまたはローカリゼーションキーのいずれかです。

フォーマット処理時に、ソースロガーがローカリゼーション ResourceBundle を持っており、その ResourceBundle がこのメッセージ文字列に対するエントリを持っている場合は、メッセージ文字列はローカライズされた値に置き換えられます。

戻り値:

未変換のメッセージ文字列

setMessage

public void setMessage(String message)

地域化またはフォーマット処理の前に、未変換のログメッセージを設定します。

パラメータ:

message - 未変換のメッセージ文字列 (null の場合もある)

getParameters

public Object[] getParameters()

ログメッセージにパラメータを返します。

戻り値:

ログメッセージのパラメータパラメータが存在しない場合は null

setParameters

public void setParameters(Object[] parameters)

ログメッセージにパラメータを設定します。

パラメータ:

parameters - ログメッセージのパラメータ(null も可能)

getThreadID

public int getThreadID()

メッセージの発生元のスレッドの識別子を返します。

これは Java VM 内のスレッド識別子であり、任意のオペレーティングシステム識別子にマッピングされる場合とされない場合があります。

戻り値:

スレッド ID

setThreadID

public void setThreadID(int threadID)

メッセージの発生元のスレッドの識別子を設定します。

パラメータ:

threadID - スレッドの ID

getMillis

public long getMillis()

1970 年以降のイベントの時間を返します (ミリ秒単位)。

戻り値:

1970 年以降のイベントの時間 (ミリ秒単位)

setMillis

public void setMillis(long millis)

イベントの時間を設定します。

パラメータ:

millis - 1970 年以降のイベントの時間 (ミリ秒単位)

getThrown

public Throwable getThrown()

ログレコードに関連した Throwable を返します。

イベントが例外を含む場合、これは例外オブジェクトになります。含まない場合は null になります。

戻り値:

throwable

setThrown

public void setThrown(Throwable thrown)

ログイベントに関連した Throwable を設定します。

パラメータ:

thrown - スロー可能オブジェクト (null も可能)