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

クラス BmsLoadHandler.TestResult

    • フィールドの詳細

      • RESULT_OK

        public static final int RESULT_OK
        検査に合格したことを示す値です。
        関連項目:
        定数フィールド値
      • RESULT_FAIL

        public static final int RESULT_FAIL
        検査に失敗したことを示す値です。
        関連項目:
        定数フィールド値
      • RESULT_THROUGH

        public static final int RESULT_THROUGH
        検査した要素を読み飛ばすことを示す値です。
        関連項目:
        定数フィールド値
      • OK

        public static final BmsLoadHandler.TestResult OK
        検査に合格したことを示します。
        この値を返すと、当該要素はBMSコンテンツの一部として取り込まれます。
      • THROUGH

        public static final BmsLoadHandler.TestResult THROUGH
        検査した要素を読み飛ばすことを示します。
        この値を返すと当該要素は破棄され、BMSコンテンツには取り込まれません。
    • メソッドの詳細

      • getResult

        public final int getResult()
        検査結果を取得します。

        この値が示すのは RESULT_OK, RESULT_FAIL, RESULT_THROUGH のいずれかです。

        戻り値:
        検査結果の値
      • getMessage

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

        検査結果が RESULT_FAIL になった場合に読み込みハンドラが検査失敗理由等を通知したい場合に 用いることを想定しています。検査失敗以外の結果ではメッセージを参照する機会がないためnullとなります。

        戻り値:
        メッセージ
      • fail

        public static BmsLoadHandler.TestResult fail​(String message)
        メッセージ付きの検査失敗を生成します。

        読み込みハンドラが検査失敗理由等を通知したい場合に当メソッドを用いてメッセージ付きの検査失敗を 生成することができます。標準の検査失敗オブジェクト(FAIL)はメッセージを保有していません。

        パラメータ:
        message - 検査失敗に付加したいメッセージ
        戻り値:
        引数で指定したメッセージを持つ検査失敗オブジェクト