uCosminexus DocumentBroker Version 5 リファレンス API

[目次][用語][索引][前へ][次へ]

11.1.5 errorエラー情報の出力

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

ユーザアプリケーションプログラムにエラーが発生したときのエラー情報を出力します。引数で指定したメッセージまたは例外クラスを出力します。このメソッドは,ユーザアプリケーションプログラムのエラー発生時に実行してください。

(2) 形式

エラー情報をメッセージにして出力する場合は,形式1〜形式3の形式で指定してください。通常の例外の情報を出力する場合は,形式4〜形式6の形式で指定してください。DocumentBrokerクラスライブラリの例外の情報を出力する場合は,形式7〜形式9の形式で指定してください。

(a) 形式1
void error(
    String        message,
    DbjTraceDef   level,
    int           output
)
(b) 形式2
void error(
    String        message,
    DbjTraceDef   level
)

形式2の場合,トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。

(c) 形式3
void error(
    String        message
)

形式3の場合,トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。また,トレースレベルはDbjTraceDef.ERRORになります。

(d) 形式4
void error(
    Exception     ex,
    DbjTraceDef   level,
    int           output
)
(e) 形式5
void error(
    Exception     ex,
    DbjTraceDef   level
)

形式5の場合,トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。

(f) 形式6
void error(
    Exception     ex
)

形式6の場合,トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。また,トレースレベルはDbjTraceDef.ERRORになります。

(g) 形式7
void error(
    DbjException   ex,
    DbjTraceDef    level,
    int            output
)
(h) 形式8
void error(
    DbjException   ex,
    DbjTraceDef    level
)

形式8の場合,トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。

(i) 形式9
void error(
    DbjException   ex
)

形式9の場合,トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。また,トレースレベルはDbjTraceDef.ERRORになります。

(3) 引数

message(入力)
出力するメッセージを指定します。
ex(入力)
発生した例外クラスを指定します。
Exceptionクラスおよびそのサブクラスを指定した場合は,ex.getMessage()およびex.printStackTrace()の内容が出力されます。
level(入力)
トレースレベルを指定します。次に示すトレースレベルのうち,どれかを指定してください。
  • DbjTraceDef.ERROR
    障害監視レベル
  • DbjTraceDef.MANAGE
    通常運用レベル
  • DbjTraceDef.HINT
    障害調査レベル
  • DbjTraceDef.DEBUG
    デバッグレベル
output(入力)
トレース情報の出力先を指定します。次に示す出力先を指定できます。
  • DbjTraceDef.PROMPT
    コマンドプロンプト(標準出力・標準エラー出力)に出力します。
  • DbjTraceDef.TRACE
    アプリケーショントレースファイルに出力します。
  • DbjTraceDef.ERRORLOG
    アプリケーションエラーログファイルに出力します。
前記以外の出力先を指定した場合,トレース情報は出力されません(実行したメソッドは正常終了します)。
複数の出力先を指定する場合は,OR演算子を用いて定数を連結してください。例えば,DbjTraceDef.TRACEとDbjTraceDef.ERRRORLOGに同時出力する場合は,DbjTraceDef.TRACE | DbjTraceDef.ERRORLOGと指定してください。

(4) 戻り値

なし

(5) 例外

なし