パッケージ com.lmt.lib.bms

クラス BmsError

  • 直系の既知のサブクラス:
    BmsScriptError
    public class BmsError
extends Object
    BMSに関連するエラー情報を表します。

    保有できる情報はJava標準の例外(Exception)とほぼ同等ですが、当クラスの目的は例外とは異なります。 BMSに関連する処理では、読み込み等の1操作について一度に複数のエラーが発生することがあり、発生したエラーをリスト化したい ケースが度々あります。そのようなケースでは、例外オブジェクトとして情報を持つとスタックトレース等の冗長な情報を 大量に保有することになり、メモリ使用量の観点で好ましくない状況となります。

    当クラスでは保有する情報は以下の通りです。

    • エラー種別
      BmsErrorTypeで列挙するエラーの種類を示す値です。この値は、主にBMS読み込みにおいて散見されるエラーの種類を 大まかに分類したものにになっています。より厳密なエラー処理を行いたいアプリケーションでは、エラーになった箇所を分析し、 エラー発生後の振る舞いを決定するべきです。

    • エラーメッセージ(オプション)
      発生したエラーの詳細情報が含まれるメッセージです。エラーの内容によっては具体的なエラー原因を示す文字列が 設定されることがありますが未設定(null)の場合もあります。

    • エラー原因となった例外(オプション)
      発生したエラーの直接的な原因となった例外を示します。アプリケーションはこの例外を用いて処理を分岐したり、 例外の詳細な内容をログ出力したりすることができます。例外に起因しないエラーも多数あるため、多くのケースでこの値は 未設定(null)を示します。

    • コンストラクタの詳細

      • BmsError

        public BmsError​(String message)
        新しいBMSエラー情報オブジェクトを汎用BMSエラー情報として構築します。
        パラメータ:
        message - エラーメッセージ

      • BmsError

        public BmsError​(String message,
                Throwable cause)
        新しいBMSエラー情報オブジェクトを汎用BMSエラー情報として構築します。

        何らかの例外がスローされたことによるエラーの場合、スローされた例外を入力情報とすることを想定しています。

        パラメータ:
        message - エラーメッセージ
        cause - エラー原因となった例外

    • メソッドの詳細

      • toString

        public String toString()
        このBMSエラー情報の文字列表現を取得します。

        汎用BMSエラー情報の場合、当メソッドが返す内容はエラーメッセージと等価になります。 ただし、エラーメッセージにnullが設定された場合は空文字を返します。

        オーバーライド:
        toString クラス内 Object
        戻り値:
        BMSエラー情報の文字列表現

      • getType

        public final BmsErrorType getType()
        エラー種別を取得します。
        戻り値:
        エラー種別

      • getMessage

        public String getMessage()
        エラーメッセージを取得します。

        この情報は任意情報です。未設定の場合、nullが返ります。

        戻り値:
        エラーメッセージ

      • getCause

        public Throwable getCause()
        エラー原因となった例外を取得します。

        この情報は任意情報です。未設定の場合、nullが返ります。

        戻り値:
        エラー原因となった例外