31.3 apex.debugネームスペース

このネームスペースは、Oracle Application Expressのすべてのデバッグ・ファンクションを格納します。

31.3.1 ログ・レベルの定数

LOG_LEVEL

apex.debug.LOG_LEVEL = {
        OFF: 0,
        ERROR: 1,
        WARN: 2,
        INFO: 4,
        APP_TRACE: 6,
        ENGINE_TRACE: 9
    };

表31-2 LOG_LEVELの説明

値	説明
`OFF: 0`	ロギングは無効です。
`ERROR: 1`	エラー・ログ・レベル。
`WARN: 2`	警告ログ・レベル。
`INFO: 4`	情報ログ・レベル。
`APP_TRACE: 6`	アプリケーション・トレース・ログ・レベル。
`ENGINE_TRACE: 9`	エンジン・トレース・ログ・レベル。

31.3.2 apex.debug.error

エラー・メッセージをログに記録します。errorファンクションは、サーバーからまたはapex.debug.setLevelを使用して設定されたログ・レベルに関係なく常にエラーを書き込みます。メッセージは、使用可能な場合、ブラウザの組込みコンソール・ロギングを使用して書き込まれます。サポートされている場合、console.traceがコールされます。古いブラウザでは、コンソール・オブジェクトやその機能の一部がサポートされていないこともあります。

パラメータ

表31-3 debug.errorのパラメータ

名前	タイプ	説明
...*	任意	コンソールにログが出力される任意の数のパラメータ。

例1

この例では、メッセージ"Update Failed"をコンソールに出力します。

apex.debug.error("Update Failed");

例2

この例では、例外メッセージをコンソールに出力します。

apex.debug.error("Exception: ", ex);

31.3.3 apex.debug.getLevel

デバッグ・ログ・レベルを戻すメソッド。デバッグ・ログ・レベルは非表示のアイテム"#pdebug"と同期がとられます。

パラメータ

なし

戻り値

ログ・レベルを整数の1から9、またはデバッグ・ログが無効になっていることを示す0 (ゼロ)として戻します。

例

この例では、ログ・レベルを取得し、先頭に"Level"を付け、コンソールにログを出力します。

apex.debug.log("Level=", apex.debug.getLevel());

参照:

戻り値の意味は、「ログ・レベルの定数」を参照してください。

31.3.4 apex.debug.info

情報メッセージをログに記録します。レベルをINFOに設定したapex.debug.messageと同様です。

パラメータ

表31-4 debug.infoのパラメータ

名前	タイプ	説明
...*	任意	コンソールにログが出力される任意の数のパラメータ。

例

この例では、ログ・レベルがINFO以上の場合に、情報メッセージをコンソールに出力します。

apex.debug.info("Command successful");

31.3.5 apex.debug.log

メッセージをログに記録します。レベルを最高レベルに設定したapex.debug.messageと同様です。

パラメータ

表31-5 debug.logのパラメータ

名前	タイプ	説明
...*	任意	コンソールにログが出力される任意の数のパラメータ。

例

この例では、現在のログ・レベルに関係なく、ログ・レベルを取得してコンソールに出力します。

apex.debug.log("Level=", apex.debug.getLevel());

31.3.6 apex.debug.message

指定されたデバッグ・ログ・レベルでメッセージをログに記録します。サーバーからまたはapex.debug.setLevelを使用して設定されたログ・レベルは、メッセージを実際に書き込むかどうかを制御します。設定されたログ・レベルがpLevel以上である場合、メッセージは書き込まれます。メッセージは、使用可能な場合、ブラウザの組込みコンソール・ロギングを使用して書き込まれます。古いブラウザでは、コンソール・オブジェクトやその機能の一部がサポートされていないこともあります。

パラメータ

表31-6 debug.messageのパラメータ

名前	タイプ	説明
`pLevel`	NUMBER	1から9の数値で、レベル1は最も重要であり、レベル9は最も重要ではありません。`LOG_LEVEL`の定数のいずれかを指定できます。0 (ゼロ)などの他の値は、デバッグ・ログを無効にします。
...*	任意	コンソールにログが出力される任意の数のパラメータ。

例

この例では、ログ・レベルが7以上である場合、メッセージ"Testing"をコンソールに出力します。

apex.debug.message(7,"Testing"));

31.3.7 apex.debug.setLevel

デバッグ・ログ・レベルを設定するメソッド。指定されたレベル以下のログ・メッセージがコンソール・ログに書き込まれます。デバッグ・ログ・レベルは、サーバーから取得される非表示のアイテム#pdebugと同期がとられるため、このファンクションをコールする必要はほとんどありません。

パラメータ

表31-7 debug.setlevelのパラメータ

名前	タイプ	説明
`pLevel`	NUMBER	1から9の数値で、レベル1は最も重要であり、レベル9は最も重要ではありません。`LOG_LEVEL`の定数のいずれかを指定できます。0 (ゼロ)などの他の値は、デバッグ・ログを無効にします。

例

この例では、ログ・レベルをアプリケーション・トレースに設定します。

apex.debug.setLevel(apex.debug.LOG_LEVEL.APP_TRACE));

31.3.8 apex.debug.trace

トレース・メッセージをログに記録します。レベルをAPP_TRACEに設定した apex.debug.messageと同様です。

パラメータ

表31-8 debug.traceのパラメータ

名前	タイプ	説明
...*	任意	コンソールにログが出力される任意の数のパラメータ。

例

この例では、デバッグ・ログ・レベルがAPP_TRACE以上の場合に、ログ・メッセージをコンソールに出力します。

apex.debug.trace("Got click event: ", event);

31.3.9 apex.debug.warn

警告メッセージをログに記録します。レベルをWARNに設定した apex.debug.messageと同様です。

パラメータ

表31-9 debug.warnのパラメータ

名前	タイプ	説明
...*	任意	コンソールにログが出力される任意の数のパラメータ。

例

この例では、デバッグ・ログ・レベルがWARN以上の場合に、警告メッセージをコンソールに出力します。

apex.debug.warn("Empty string ignored");