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

インタフェース BmsChx

    • メソッドの概要

      すべてのメソッド staticメソッド インスタンス・メソッド abstractメソッド デフォルト・メソッド 
      修飾子とタイプ メソッド 説明
      static int compare​(BmsChx chx1, BmsChx chx2)
      2つのCHXを比較します。
      static boolean equals​(BmsChx chx1, BmsChx chx2)
      2つのCHXを比較し、同じ場所を指しているかどうかを判定します。
      int getChannel()
      チャンネル番号を取得します。
      int getIndex()
      チャンネルインデックスを取得します。
      static int hashCode​(BmsChx chx)
      CHXからハッシュコード値を生成します。
      default boolean isMeasureLineChannel()
      チャンネル番号が小節線チャンネルかどうかを判定します。
      default boolean isSpecChannel()
      チャンネル番号が仕様チャンネルかどうかを判定します。
      default boolean isUserChannel()
      チャンネル番号がユーザーチャンネルかどうかを判定します。
      static int toChannel​(int chx)
      CHX値からチャンネル番号を取得します。
      static int toIndex​(int chx)
      CHX値からチャンネルインデックスを取得します。
      static int toInt​(int channel)
      チャンネル番号からCHX値に変換します。
      static int toInt​(int channel, int index)
      チャンネル番号とチャンネルインデックスからCHX値に変換します。
      static int toInt​(BmsChx chx)
      CHXからCHX値に変換します。
      static String toString​(int chx)
      CHX値の文字列表現を返します。
      static String toString​(BmsChx chx)
      CHXの文字列表現を返します。
    • メソッドの詳細

      • getChannel

        int getChannel()
        チャンネル番号を取得します。
        戻り値:
        チャンネル番号
      • getIndex

        int getIndex()
        チャンネルインデックスを取得します。
        戻り値:
        チャンネルインデックス
      • isMeasureLineChannel

        default boolean isMeasureLineChannel()
        チャンネル番号が小節線チャンネルかどうかを判定します。

        当メソッドの結果がtrueの場合、getChannel()が返す値がBmsSpec.CHANNEL_MEASUREであることを示します。

        戻り値:
        チャンネル番号が小節線チャンネルの場合true
      • isSpecChannel

        default boolean isSpecChannel()
        チャンネル番号が仕様チャンネルかどうかを判定します。

        当メソッドの結果がtrueの場合、getChannel()が返す値が BmsSpec.SPEC_CHANNEL_MINBmsSpec.SPEC_CHANNEL_MAXの範囲であることを示します。

        戻り値:
        チャンネル番号が仕様チャンネルの場合true
      • isUserChannel

        default boolean isUserChannel()
        チャンネル番号がユーザーチャンネルかどうかを判定します。

        当メソッドの結果がtrueの場合、getChannel()が返す値が BmsSpec.USER_CHANNEL_MINBmsSpec.USER_CHANNEL_MAXの範囲であることを示します。

        戻り値:
        チャンネル番号がユーザーチャンネルの場合true
      • equals

        static boolean equals​(BmsChx chx1,
                              BmsChx chx2)
        2つのCHXを比較し、同じ場所を指しているかどうかを判定します。
        パラメータ:
        chx1 - CHX1
        chx2 - CHX2
        戻り値:
        2つのCHXが同じ場所を指していればtrue
        例外:
        NullPointerException - chx1またはchx2がnull
      • compare

        static int compare​(BmsChx chx1,
                           BmsChx chx2)
        2つのCHXを比較します。
        パラメータ:
        chx1 - CHX1
        chx2 - CHX2
        戻り値:
        CHX1 == CHX2は0、CHX1 > CHX2は正の値、CHX1 < CHX2は負の値
        例外:
        NullPointerException - chx1またはchx2がnull
      • hashCode

        static int hashCode​(BmsChx chx)
        CHXからハッシュコード値を生成します。
        パラメータ:
        chx - CHX
        戻り値:
        ハッシュコード値
        例外:
        NullPointerException - chxがnull
      • toString

        static String toString​(BmsChx chx)
        CHXの文字列表現を返します。
        パラメータ:
        chx - CHX
        戻り値:
        CHXの文字列表現
        例外:
        NullPointerException - chxがnull
      • toString

        static String toString​(int chx)
        CHX値の文字列表現を返します。
        パラメータ:
        chx - CHX値
        戻り値:
        CHX値の文字列表現
      • toInt

        static int toInt​(int channel,
                         int index)
        チャンネル番号とチャンネルインデックスからCHX値に変換します。

        CHX値は、チャンネル番号とチャンネルインデックスを1個の32ビット整数値として表現した値のことを指します。 指定したチャンネル番号、チャンネルインデックスは下位16ビットのみを使用し0~65535までの値になります。 上位16ビットがどのような状態であってもCHX値の計算結果には影響を及ぼしません。また、BmsSpecで定義された 範囲外の値を指定しても範囲内チェックは行われず、例外もスローされません。

        パラメータ:
        channel - チャンネル番号
        index - チャンネルインデックス
        戻り値:
        CHX値
      • toInt

        static int toInt​(int channel)
        チャンネル番号からCHX値に変換します。

        CHX値は、チャンネル番号とチャンネルインデックスを1個の32ビット整数値として表現した値のことを指します。 当メソッドではチャンネルインデックスは0が指定されたものとしてCHX値への変換を行います。 指定したチャンネル番号は下位16ビットのみを使用し0~65535までの値になります。 上位16ビットがどのような状態であってもCHX値の計算結果には影響を及ぼしません。また、BmsSpecで定義された 範囲外の値を指定しても範囲内チェックは行われず、例外もスローされません。

        パラメータ:
        channel - チャンネル番号
        戻り値:
        CHX値
      • toInt

        static int toInt​(BmsChx chx)
        CHXからCHX値に変換します。

        CHX値は、チャンネル番号とチャンネルインデックスを1個の32ビット整数値として表現した値のことを指します。 指定したチャンネル番号、チャンネルインデックスは下位16ビットのみを使用し0~65535までの値になります。 上位16ビットがどのような状態であってもCHX値の計算結果には影響を及ぼしません。また、BmsSpecで定義された 範囲外の値を指定しても範囲内チェックは行われず、例外もスローされません。

        パラメータ:
        chx - CHX
        戻り値:
        CHX値
        例外:
        NullPointerException - chxがnull
      • toChannel

        static int toChannel​(int chx)
        CHX値からチャンネル番号を取得します。

        CHX値は生成の際に範囲外チェックを行わないため、BmsSpec.CHANNEL_MINBmsSpec.CHANNEL_MAX の範囲外になることがあることに注意してください。

        パラメータ:
        chx - CHX値
        戻り値:
        チャンネル番号
      • toIndex

        static int toIndex​(int chx)
        CHX値からチャンネルインデックスを取得します。

        CHX値は生成の際に範囲外チェックを行わないため、BmsSpec.CHINDEX_MINBmsSpec.CHINDEX_MAX の範囲外になることがあることに注意してください。

        パラメータ:
        chx - CHX値
        戻り値:
        チャンネルインデックス