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

クラス BmsTestResult

Object

BmsTestResult

public class BmsTestResult
extends Object

BMS宣言、メタ情報、タイムライン要素、およびBMSコンテンツの検査結果を示すクラスです。
当クラスは以下のメソッドの戻り値として使用します。

• BMS宣言の検査：BmsLoadHandler.testDeclaration(String, String)
• メタ情報の検査：BmsLoadHandler.testMeta(BmsMeta, int, Object)
• タイムライン要素の検査：BmsLoadHandler.testChannel(BmsChannel, int, int, Object)
• BMSコンテンツの検査：BmsLoadHandler.testContent(BmsContent)

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
static BmsTestResult	FAIL	検査に失敗したことを示します。
static BmsTestResult	OK	検査に合格したことを示します。
static int	RESULT_FAIL	検査に失敗したことを示す値です。
static int	RESULT_OK	検査に合格したことを示す値です。
static int	RESULT_THROUGH	検査した要素を読み飛ばすことを示す値です。
static BmsTestResult	THROUGH	検査した要素を読み飛ばすことを示します。

メソッドの概要

修飾子とタイプ	メソッド	説明
static BmsTestResult	fail(String message)	メッセージ付きの検査失敗を生成します。
String	getMessage()	メッセージを取得します。
int	getResult()	検査結果を取得します。

クラスから継承されたメソッド Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

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 BmsTestResult OK

検査に合格したことを示します。
この値を返すと、当該要素はBMSコンテンツの一部として取り込まれます。

FAIL

public static final BmsTestResult FAIL

検査に失敗したことを示します。
この値を返すと当該要素は破棄され、BmsLoadHandler.parseError(BmsScriptError)が呼ばれます。

THROUGH

public static final BmsTestResult THROUGH

検査した要素を読み飛ばすことを示します。
この値を返すと当該要素は破棄され、BMSコンテンツには取り込まれません。

メソッドの詳細

getResult

public final int getResult()

検査結果を取得します。

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

戻り値:

検査結果の値

getMessage

public final String getMessage()

メッセージを取得します。

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

戻り値:

メッセージ

fail

public static BmsTestResult fail(String message)

メッセージ付きの検査失敗を生成します。

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

パラメータ:

message - 検査失敗に付加したいメッセージ

戻り値:

引数で指定したメッセージを持つ検査失敗オブジェクト