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

クラス BmsLoadError


  • public class BmsLoadError
    extends Object
    BMSコンテンツの読み込み中に発生したエラーの情報を表します。

    BmsLoaderでBMSコンテンツを外部データから読み込む工程において、エラーを検出した場合に通知される 一連の情報を表します。アプリケーションはBmsLoader.setHandler(BmsLoadHandler)で指定したハンドラの BmsLoadHandler.parseError(BmsLoadError)によりこの情報の通知を受け、BMSコンテンツの読み込み続行有無を 決定することができます。

    エラー情報について
    当クラスで通知するエラー情報には次のようなものがあります。

    • エラー種別
      BmsLoadError.Kindで列挙するエラーの種類を示す値です。この値は、外部データ解析において散見される解析エラーの 種類を大まかに分類したものに過ぎません。より厳密な動作を行いたいアプリケーションでは、解析エラーになった行の内容を 分析し、読み込み中止有無を判断すべきです。
    • 行番号
      解析エラーが発生した外部データ上の行の番号を示します。この値はアプリケーションのユーザーに対して、外部データの どこでエラーが発生したかを示す目的で使用することができます。
    • 行の内容
      解析エラーとなった外部データ上の行の記述内容そのものを示します。行番号と同様、ユーザーに対してどのような内容の記述が エラーになったかを示す目的で使用できます。
    • メッセージ
      発生したエラーの詳細情報が含まれるメッセージです。エラーの内容によっては具体的なエラー原因を示す文字列が 設定されることがありますが、未設定の場合もあります。
    • コンストラクタの詳細

      • BmsLoadError

        public BmsLoadError​(BmsLoadError.Kind kind,
                            int lineNumber,
                            String line)
        BMSフォーマット読み込みエラーを構築します。

        このクラスのインスタンスはBmsLoaderが生成することを想定しており、アプリケーションが独自に インスタンスを生成することは推奨されません。

        パラメータ:
        kind - エラー種別
        lineNumber - 行番号
        line - 行の記述内容
        例外:
        NullPointerException - kindがnull
        NullPointerException - lineがnull
        IllegalArgumentException - lineNumberがマイナス値
    • メソッドの詳細

      • toString

        public String toString()
        このBMS読み込みエラーの一般的なエラーメッセージを返します。
        オーバーライド:
        toString クラス内 Object
        戻り値:
        エラーメッセージ
      • getKind

        public BmsLoadError.Kind getKind()
        エラー種別を取得します。
        戻り値:
        エラー種別
      • getLineNumber

        public int getLineNumber()
        エラー発生行の行番号を取得します。
        戻り値:
        行番号
      • getLine

        public String getLine()
        エラー発生行の記述を取得します。
        戻り値:
        行の記述内容
      • getMessage

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

        エラーメッセージは任意項目です。エラー発生元でメッセージを設定しなかった場合、nullが返ります。

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