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

クラス BmsScriptError

Object

BmsError

BmsScriptError

public class BmsScriptError
extends BmsError

BMSの読み込み中に発生したエラーの情報を表します。

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

当クラスでは、親クラスであるBmsErrorが持つエラー情報に加え以下の情報を保有します。

• 行番号
  解析エラーが発生した外部データ上の行の番号を示します。この値はアプリケーションのユーザーに対して、 外部データのどこでエラーが発生したかを示す目的で使用することができます。
  
  
• 行の内容
  解析エラーとなった外部データ上の行の記述内容そのものを示します。行番号と同様、アプリケーションに対してどのような内容の記述が エラーになったかを示す目的で使用できます。

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
BmsScriptError(BmsErrorType errType, int lineNumber, String line, String message, Throwable throwable)	BMSフォーマット読み込みエラーを構築します。

メソッドの概要

修飾子とタイプ	メソッド	説明
String	getLine()	エラー発生行の記述を取得します。
int	getLineNumber()	エラー発生行の行番号を取得します。
String	toString()	このBMS読み込みエラーの一般的なエラーメッセージを返します。

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

getCause, getMessage, getType

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

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

コンストラクタの詳細

BmsScriptError

public BmsScriptError(BmsErrorType errType,
                      int lineNumber,
                      String line,
                      String message,
                      Throwable throwable)

BMSフォーマット読み込みエラーを構築します。

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

パラメータ:

errType - エラー種別

lineNumber - 行番号

line - 行の記述内容

message - エラーメッセージ

throwable - 発生した例外

例外:

NullPointerException - errTypeがnull

NullPointerException - lineがnull

IllegalArgumentException - lineNumberがマイナス値

メソッドの詳細

toString

public String toString()

このBMS読み込みエラーの一般的なエラーメッセージを返します。

オーバーライド:

toString クラス内 BmsError

戻り値:

エラーメッセージ

getLineNumber

public final int getLineNumber()

エラー発生行の行番号を取得します。

戻り値:

行番号

getLine

public final String getLine()

エラー発生行の記述を取得します。

戻り値:

行の記述内容