JavaTM 2 Platform
Standard Ed. 5.0

java.util.logging
クラス LogRecord

java.lang.Object
  上位を拡張 java.util.logging.LogRecord
すべての実装されたインタフェース:
Serializable

public class LogRecord
extends Object
implements Serializable

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

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

クライアントアプリケーションが、ソースメソッド名とソースクラス名を明示的に指定しない場合、getSourceMethodName または getSourceClassName の呼び出しにより最初にアクセスされたときに、LogRecord クラスは呼び出しスタックを分析して自動的にこれらの名前を推定することに注意してください。したがって、ログ Handler が LogRecord をほかのスレッドに渡そうとする場合、または RMI を介して転送しようとする場合、およびそのあとにメソッド名とクラス名の情報を取得しようとする場合、getSourceClassName または getSourceMethodName のいずれかを呼び出して、その値が書き込まれるようにしなければなりません。

直列化に関する注意:

導入されたバージョン:
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 を構築します。

シーケンスプロパティは新しい一意の値で初期化されます。これらの連続する値は 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()
ロギングの要求を発行したか、発行したと見なされるクラスの名前を返します。

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

情報が取得されない場合は 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 - throwable (null の場合がある)

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。