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

クラス ContentDescription

  • public class ContentDescription
extends Object
    1個の楽曲情報を表すクラスです。

    難易度表の楽曲情報として必須の情報は、楽曲のタイトル・アーティスト、および当該難易度表での難易度となります。 当クラスではそれ以外にも対象楽曲の入手に必要な情報や検索に役立つ任意情報を保有します。 これらの情報を保有するかどうかは難易度表、または楽曲ごとに異なります。

    導入されたバージョン:
    0.1.0

    • コンストラクタの詳細

      • ContentDescription

        public ContentDescription​(String title,
                          String artist,
                          PlayStyle playStyle,
                          int levelIndex,
                          URL bodyUrl,
                          URL additionalUrl,
                          String md5,
                          String sha256)
        新しい楽曲情報オブジェクトを構築します。

        当クラスのオブジェクト構築は当ライブラリのユーザーが直接行うことを想定していません。 楽曲情報の管理・更新は ContentDatabase を利用して間接的に行うことを推奨します。

        パラメータ:
        title - タイトル
        artist - アーティスト
        playStyle - プレースタイル
        levelIndex - 難易度インデックス、または null
        bodyUrl - 楽曲本体入手先URL、または null
        additionalUrl - 差分譜面入手先URL、または null
        md5 - MD5、または null
        sha256 - SHA-256、または null
        例外:
        NullPointerException - title が null
        NullPointerException - artist が null
        NullPointerException - playStyle が null
        IllegalArgumentException - title が空文字列
        IllegalArgumentException - levelIndex が負の値
        IllegalArgumentException - md5 がMD5の形式ではない
        IllegalArgumentException - sha256 がSHA-256の形式ではない
        導入されたバージョン:
        0.1.0

    • メソッドの詳細

      • getTitle

        public String getTitle()
        タイトルを取得します。

        この値は #TITLE の値がそのまま格納されていることが期待されます。

        戻り値:
        タイトル
        導入されたバージョン:
        0.1.0

      • getArtist

        public String getArtist()
        アーティストを取得します。

        この値は #ARTIST の値がそのまま格納されていることが期待されます。

        戻り値:
        アーティスト
        導入されたバージョン:
        0.1.0

      • getPlayStyle

        public PlayStyle getPlayStyle()
        プレースタイルを取得します。
        戻り値:
        プレースタイル
        導入されたバージョン:
        0.1.0

      • getLevelIndex

        public int getLevelIndex()
        難易度インデックスを取得します。

        この値は PlayStyleDescription.getLabels() が返すリストのインデックス値として使用する想定する値です。

        戻り値:
        難易度インデックス
        導入されたバージョン:
        0.1.0

      • getBodyUrl

        public URL getBodyUrl()
        楽曲本体入手先URLを取得します。

        このURLは当該楽曲本体、つまりBMSファイルと音声ファイル、動画ファイル等がパッケージングされたファイルの 取得元を表すURLとして格納されていることが期待されます。ただし、難易度表によってはURLが提供されなかったり、 差分譜面の入手先URLが格納されている場合があります。また、提供されるURLがリンク切れとなっている場合もありますので、 あくまで参考値として活用するようにしてください。

        信頼できないサイトが公開している難易度表に記述されたURLでは、悪意のあるサイトへ誘導される可能性があります。 アプリケーションはその点に留意して仕様を決定するようにしてください。

        戻り値:
        楽曲本体入手先URL。未提供の場合 null。
        導入されたバージョン:
        0.1.0

      • getAdditionalUrl

        public URL getAdditionalUrl()
        差分譜面入手先URLを取得します。

        このURLは当該楽曲情報が示す追加(差分)譜面の取得元を表すURLとして格納されていることが期待されます。 通常、差分譜面は1個のBMSファイルを圧縮したアーカイブファイルとして提供されることが一般的です。 楽曲本体入手先URLと同様に、URL未提供、リンク切れの可能性があることに留意してください。

        信頼できないサイトが公開している難易度表に記述されたURLでは、悪意のあるサイトへ誘導される可能性があります。 アプリケーションはその点に留意して仕様を決定するようにしてください。

        戻り値:
        差分譜面入手先URL。未提供の場合 null。
        導入されたバージョン:
        0.1.0

      • getMd5

        public String getMd5()
        MD5を取得します。

        この値は当該楽曲情報のBMSファイル全体のMD5が格納されていることが期待されます。 よって、BMSファイルの内容が1文字でも変化すると異なるハッシュ値を示すようになります。

        戻り値:
        MD5。未提供の場合 null。
        導入されたバージョン:
        0.1.0

      • getSha256

        public String getSha256()
        SHA-256を取得します。

        この値は当該楽曲情報のBMSファイル全体のSHA-256が格納されていることが期待されます。 よって、BMSファイルの内容が1文字でも変化すると異なるハッシュ値を示すようになります。

        戻り値:
        SHA-256。未提供の場合 null。
        導入されたバージョン:
        0.1.0