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

クラス BmsLibrary

  • public class BmsLibrary
extends Object
    BMSライブラリに関する基本的な情報の設定・取得を行うためのクラスです。

    • コンストラクタの詳細

      • BmsLibrary

        public BmsLibrary()

    • メソッドの詳細

      • getVersion

        public static String getVersion()
        BMSライブラリ本体のバージョンを取得します。
        戻り値:
        BMSライブラリ本体のバージョン

      • getPrimaryCharset

        public static Charset getPrimaryCharset()
        BMSライブラリが扱う最優先文字セットを取得します。

        BmsLoaderによるBMS読み込み時、スクリプトをデコードする際に最初に使用する文字セットとなります。 また、BmsSaverによるBMS書き込み時、出力文字セット未指定時の規定文字セットとしても使用されます。

        当メソッドは getDefaultCharsets().get(0) と等価です。

        戻り値:
        BMSライブラリが扱う最優先文字セット
        関連項目:
        getDefaultCharsets()

      • getDefaultCharsets

        public static List<Charset> getDefaultCharsets()
        BMSライブラリが扱うデフォルトの文字セットのリストを取得します。

        最優先文字セットはリストの先頭に格納されています。その値はgetPrimaryCharset()と等価になります。 文字セットが複数指定されている場合はリストに2個以上の文字セットが格納されています。その場合、リストの中に 同じ文字セットが格納されることはありません。

        返されるリストは変更できません。

        戻り値:
        文字セットのリスト
        関連項目:
        setDefaultCharsets(Charset...)

      • setDefaultCharsets

        public static void setDefaultCharsets​(Charset... charsets)
        BMSライブラリが扱うデフォルトの文字セットを優先順に設定します。

        パラメータの先頭で指定した文字セットが最優先文字セットになります(指定必須)。 文字セットは2個以上指定することができますが、必須ではありません。しかし、複数指定することでBmsLoader によるBMS読み込み時、文字化けの発生しない文字セットを自動的に探し出してくれるようになります。

        指定した文字セットが重複している場合、後方で指定した同一の文字セットは無視されます。

        指定する文字セットの中にnullを含めてはなりません。nullが含まれていると例外がスローされます。

        パラメータ:
        charsets - デフォルトの文字セット(複数指定可)
        例外:
        IllegalArgumentException - 文字セットが0件
        NullPointerException - 文字セットにnullが含まれている

      • printLogo

        public static void printLogo()
        BMSライブラリのロゴを標準出力に出力します。

      • printLogo

        public static void printLogo​(PrintStream ps)
        BMSライブラリのロゴを指定した出力ストリームに出力します。
        パラメータ:
        ps - ロゴの出力先ストリーム
        例外:
        NullPointerException - psがnull