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

列挙型 BmsErrorType

    • 列挙型定数の概要

      列挙定数 
      列挙型定数 説明
      COMMENT_NOT_CLOSED
      複数行コメントが閉じられずにBMSの読み込みが終了した場合を表します。
      COMMON
      汎用エラー情報であることを表します。
      ENCODING
      BMS宣言が定義されている場合で、「encoding」に記述されている文字セットが未知の内容だった時。
      PANIC
      想定外のエラーが発生したことを表します。
      REDEFINE
      単体メタ情報、または重複不可チャンネルの再定義を検出したことを表します。
      SPEC_VIOLATION
      メタ情報・チャンネルにおいて、データの値の有効範囲がBMSライブラリの定める範囲外であることを表します。
      SYNTAX
      BMSフォーマットで規定されているどの構文にも該当しない行をBMSの構文エラーを表します。
      TEST_CHANNEL
      チャンネルデータの検査に失敗した場合を表します。
      TEST_CONTENT
      BMS読み込みによって生成されたBMSコンテンツの検査に失敗した場合を表します。
      TEST_DECLARATION
      BMS宣言の検査に失敗した場合を表します。
      TEST_META
      メタ情報の検査に失敗した場合を表します。
      UNKNOWN_CHANNEL
      チャンネル定義の行で、チャンネル番号がBMS仕様(BmsSpec)に定義されていない場合を表します。
      UNKNOWN_META
      メタ情報の定義と思われる行で、そのメタ情報がBMS仕様(BmsSpec)に定義されていない場合を表します。
      WRONG_DATA
      メタ情報・チャンネルにおいて、データの記述がBMS仕様(BmsSpec)に規定のデータ型に適合しない場合を表します。

    • 列挙型定数の詳細

      • SYNTAX

        public static final BmsErrorType SYNTAX
        BMSフォーマットで規定されているどの構文にも該当しない行をBMSの構文エラーを表します。

        メタ情報、チャンネル、単一行コメント、複数行コメントのいずれにも該当しない行に対して適用されます。 半角スペース、タブのみの行は構文エラーとはなりませんが、それ以外の改行コードを除く制御文字や全角スペースが 含まれていると構文エラーとして認識されます。

        BMS読み込み時にこのエラーの発生を制御したい場合はBmsLoader.setSyntaxErrorEnable(boolean) を使用してください。

      • ENCODING

        public static final BmsErrorType ENCODING
        BMS宣言が定義されている場合で、「encoding」に記述されている文字セットが未知の内容だった時。

        具体的に、encodingに指定する値はJavaで言うところのjava.nio.charset.Charsetを生成する際に 用いられます。これを生成するのに使用できない内容だった場合を示します。

      • UNKNOWN_META

        public static final BmsErrorType UNKNOWN_META
        メタ情報の定義と思われる行で、そのメタ情報がBMS仕様(BmsSpec)に定義されていない場合を表します。

        アプリケーションによっては、未知のメタ情報をエラーとせず無視したい場合と、BMSの記述を厳密に扱い エラーとしたい場合が考えられます。BMS読み込み時にこのエラーの発生を制御したい場合は BmsLoader.setIgnoreUnknownMeta(boolean)を使用してください。

      • UNKNOWN_CHANNEL

        public static final BmsErrorType UNKNOWN_CHANNEL
        チャンネル定義の行で、チャンネル番号がBMS仕様(BmsSpec)に定義されていない場合を表します。

        UNKNOWN_METAと同様に、BMS読み込み時にこのエラーの発生を制御したい場合は BmsLoader.setIgnoreUnknownChannel(boolean)を使用してください。

      • WRONG_DATA

        public static final BmsErrorType WRONG_DATA
        メタ情報・チャンネルにおいて、データの記述がBMS仕様(BmsSpec)に規定のデータ型に適合しない場合を表します。

        このエラーを検出した行のデータはBMSコンテンツには取り込まれずに破棄されます。 BMS読み込み時にこのエラーの発生を制御したい場合はBmsLoader.setIgnoreWrongData(boolean)を使用してください。

      • REDEFINE

        public static final BmsErrorType REDEFINE
        単体メタ情報、または重複不可チャンネルの再定義を検出したことを表します。

        BMS仕様(BmsSpec)で重複が許可されていない単体メタ情報・重複不可チャンネルは同一のBMS内に複数の定義を 記述することは認められません。このエラーはBmsLoader.setAllowRedefine(boolean)を用いることで 発生を制御することができます。

      • SPEC_VIOLATION

        public static final BmsErrorType SPEC_VIOLATION
        メタ情報・チャンネルにおいて、データの値の有効範囲がBMSライブラリの定める範囲外であることを表します。

        WRONG_DATAと似ていますが、このエラーの場合データの記述ルールは誤っておらず、定義された値が BMSライブラリで取り扱い可能な範囲ではないことを示します。 BmsLoader.setFixSpecViolation(boolean)を用いることで当エラーを検出した際にエラー発出するか、 自動的に定義値を有効範囲内に補正するかを選択することができます。

      • COMMENT_NOT_CLOSED

        public static final BmsErrorType COMMENT_NOT_CLOSED
        複数行コメントが閉じられずにBMSの読み込みが終了した場合を表します。

        このエラーでは行番号は0、行の記述内容は空文字として報告されます。

      • PANIC

        public static final BmsErrorType PANIC
        想定外のエラーが発生したことを表します。

        このエラーを検出した場合はBMSの読み込みを続行するべきではありません。

      • COMMON

        public static final BmsErrorType COMMON
        汎用エラー情報であることを表します。

        このエラーはBMS読み込み時のエラーのように行番号・行文字列等の付加的なエラー情報を持ちません。 BMS読み込み時以外で発生したBMS関連のエラーをBMSエラー情報として扱いたい場合に用いることを想定しています。

    • メソッドの詳細

      • values

        public static BmsErrorType[] values()
        この列挙型の定数を含む配列を宣言されている順序で返します。 このメソッドは次のようにして定数を反復するために 使用できます: 
        for (BmsErrorType c : BmsErrorType.values())
    System.out.println(c);
        戻り値:
        この列挙型の定数を含む、宣言されている順序での配列

      • valueOf

        public static BmsErrorType valueOf​(String name)
        指定した名前を持つこの型の列挙型定数を返します。 文字列は、この型の列挙型定数を宣言するのに使用した識別子と正確に 一致している必要があります。(余分な空白文字を含めることは できません。)
        パラメータ:
        name - 返される列挙型定数の名前。
        戻り値:
        指定した名前の列挙型定数
        例外:
        IllegalArgumentException - この列挙型に、指定した名前の定数がない場合
        NullPointerException - 引数がnullの場合

      • isScriptError

        public final boolean isScriptError()
        このエラー種別がBMSの記述内容に起因するエラーかどうかを判定します。
        戻り値:
        BMSの記述内容に起因するエラーであればtrue、そうでなければfalse

      • isCommonError

        public final boolean isCommonError()
        このエラー種別が汎用エラーであるかどうかを判定します。
        戻り値:
        汎用エラーであればtrue、そうでなければfalse