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

列挙型 BmsLoadError.Kind

  • すべての実装されたインタフェース:
    Serializable, Comparable<BmsLoadError.Kind>
    含まれているクラス:
    BmsLoadError
    public static enum BmsLoadError.Kind
extends Enum<BmsLoadError.Kind>
    BMSフォーマット読み込み時に発生するエラーの種別を表します。

    • 列挙型定数の概要

      列挙定数 
      列挙型定数 説明
      COMMENT_NOT_CLOSED
      複数行コメントが閉じられずにBMSフォーマットの読み込みが終了した場合を表します。
      ENCODING
      BMS宣言が定義されている場合で、「encoding」に記述されている文字セットが未知の内容だった時。
      FAILED_TEST_CHANNEL
      チャンネルデータの検査に失敗した場合を表します。
      FAILED_TEST_CONTENT
      BMSコンテンツの検査に失敗した場合を表します。
      FAILED_TEST_DECLARATION
      BMS宣言の検査に失敗した場合を表します。
      FAILED_TEST_META
      メタ情報の検査に失敗した場合を表します。
      LIBRARY_SPEC_VIOLATION
      メタ情報・チャンネルにおいて、データの記述がBMSライブラリの定める範囲外であることを検出した場合を表します。
      PANIC
      想定外の状況が発生したことを表します。
      SYNTAX
      BMSフォーマットで規定されている、どの構文にも該当しない行を表します。
      UNKNOWN_CHANNEL
      チャンネル定義の行で、チャンネル番号がBMS仕様に存在しない場合を表します。
      UNKNOWN_META
      メタ情報の定義と思われる行で、そのメタ情報がBMS仕様に存在しない場合を表します。
      WRONG_DATA
      メタ情報・チャンネルにおいて、データの記述がBMS仕様に規定の当該定義のデータ型・重複可否に適合しない場合を表します。

    • メソッドの概要

      すべてのメソッド staticメソッド concreteメソッド 
      修飾子とタイプ メソッド 説明
      static BmsLoadError.Kind valueOf​(String name)
      指定した名前を持つこの型の列挙型定数を返します。
      static BmsLoadError.Kind[] values()
      この列挙型の定数を含む配列を宣言されている順序で返します。

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

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

        getClass, notify, notifyAll, wait, wait, wait

    • 列挙型定数の詳細

      • SYNTAX

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

        メタ情報、チャンネル、単一行コメント、複数行コメントのいずれにも該当しない行に対して適用されます。

      • ENCODING

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

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

      • UNKNOWN_META

        public static final BmsLoadError.Kind UNKNOWN_META
        メタ情報の定義と思われる行で、そのメタ情報がBMS仕様に存在しない場合を表します。

        いくつかのBMSフォーマットでは、複数のBMSプレーヤーに対応するためにマイナーなメタ情報を記述している ケースがあるため、このエラーを検出したとしてもBMSフォーマットの解析をエラー終了することは、 一般的なBMSプレーヤー、およびBMSエディタにおいては推奨されません。

      • UNKNOWN_CHANNEL

        public static final BmsLoadError.Kind UNKNOWN_CHANNEL
        チャンネル定義の行で、チャンネル番号がBMS仕様に存在しない場合を表します。

        メタ情報のケースと同様に、複数のBMSプレーヤーに対応するためのマイナーなチャンネルを記述している ことがあるため、このエラーによるBMSフォーマットの解析終了は推奨されません。

      • WRONG_DATA

        public static final BmsLoadError.Kind WRONG_DATA
        メタ情報・チャンネルにおいて、データの記述がBMS仕様に規定の当該定義のデータ型・重複可否に適合しない場合を表します。

        このエラーを検出した行のデータはBMSコンテンツには取り込まれずに捨てられます。そのような挙動が 望ましくないアプリケーションでは、BMSフォーマットの読み込みをエラーとして扱うべきです。

      • LIBRARY_SPEC_VIOLATION

        public static final BmsLoadError.Kind LIBRARY_SPEC_VIOLATION
        メタ情報・チャンネルにおいて、データの記述がBMSライブラリの定める範囲外であることを検出した場合を表します。

        WRONG_DATAと似ていますが、こちらはBMSライブラリとしての仕様違反を示しています。 BmsLoader.setFixSpecViolation(boolean)を用いることで当エラーを検出した際にエラー発出するか、自動的に 値の補正を行うかを選択することができます。

      • COMMENT_NOT_CLOSED

        public static final BmsLoadError.Kind COMMENT_NOT_CLOSED
        複数行コメントが閉じられずにBMSフォーマットの読み込みが終了した場合を表します。

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

      • PANIC

        public static final BmsLoadError.Kind PANIC
        想定外の状況が発生したことを表します。
        このエラーを検出した場合はBMSコンテンツ読み込みを続行するべきではありません。

    • メソッドの詳細

      • values

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

      • valueOf

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