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

クラス BmsMetaElement


  • public class BmsMetaElement
    extends Object
    メタ情報とインデックス値、およびその値がセットになった要素クラスです。

    当クラスはメタ情報をストリームAPIで走査する際に1つのメタ情報にアクセスするためのデータコンテナの役割を果たします。

    • メソッドの概要

      すべてのメソッド インスタンス・メソッド concreteメソッド 
      修飾子とタイプ メソッド 説明
      <T> T getDefault()
      メタ情報のデフォルト値を指定した型にキャストして取得します。
      BmsArray getDefaultAsArray()
      メタ情報のデフォルト値をBmsArray型で取得します。
      double getDefaultAsDouble()
      メタ情報のデフォルト値をdouble型で取得します。
      long getDefaultAsLong()
      メタ情報のデフォルト値をlong型で取得します。
      String getDefaultAsString()
      メタ情報のデフォルト値をString型で取得します。
      int getIndex()
      インデックス値を取得します。
      BmsMeta getMeta()
      メタ情報を取得します。
      String getName()
      メタ情報の名前を取得します。
      BmsType getType()
      メタ情報のデータ型を取得します。
      BmsUnit getUnit()
      メタ情報の構成単位を取得します。
      <T> T getValue()
      メタ情報の値を指定した型にキャストして取得します。
      BmsArray getValueAsArray()
      メタ情報の値をBmsArray型で取得します。
      double getValueAsDouble()
      メタ情報の値をdouble型で取得します。
      long getValueAsLong()
      メタ情報の値をlong型で取得します。
      String getValueAsString()
      メタ情報の値をString型で取得します。
      boolean isArray16Type()
      このメタ情報のデータ型が16進数値配列かどうかを取得します。
      boolean isArray36Type()
      このメタ情報のデータ型が36進数値配列かどうかを取得します。
      boolean isArrayType()
      このメタ情報のデータ型が配列型かどうかを取得します。
      boolean isBase16Type()
      このメタ情報のデータ型が16進数値かどうかを取得します。
      boolean isBase36Type()
      このメタ情報のデータ型が36進数値かどうかを取得します。
      boolean isContain()
      このメタ情報にデータが設定されているかどうかを取得します。
      boolean isFloatType()
      このメタ情報のデータ型が実数かどうかを取得します。
      boolean isIndexedUnit()
      このメタ情報が索引付きメタ情報かどうかを取得します。
      boolean isIntegerType()
      このメタ情報のデータ型が整数かどうかを取得します。
      boolean isMultipleUnit()
      このメタ情報が複数メタ情報かどうかを取得します。
      boolean isNormalType()
      このメタ情報のデータ型が通常型かどうかを取得します。
      boolean isNumberType()
      このメタ情報のデータ型が数値型かどうかを取得します。
      boolean isObjectType()
      このメタ情報のデータ型が任意型かどうかを取得します。
      boolean isSingleUnit()
      このメタ情報が単体メタ情報かどうかを取得します。
      boolean isStringType()
      このメタ情報のデータ型が文字列かどうかを取得します。
      boolean isValueType()
      このメタ情報のデータ型が値型かどうかを取得します。
    • メソッドの詳細

      • getMeta

        public final BmsMeta getMeta()
        メタ情報を取得します。
        戻り値:
        メタ情報
      • getName

        public final String getName()
        メタ情報の名前を取得します。
        戻り値:
        メタ情報の名前
      • getUnit

        public final BmsUnit getUnit()
        メタ情報の構成単位を取得します。
        戻り値:
        メタ情報の構成単位
      • getType

        public final BmsType getType()
        メタ情報のデータ型を取得します。
        戻り値:
        メタ情報のデータ型
      • getIndex

        public final int getIndex()
        インデックス値を取得します。

        単体メタ情報の場合、常に0を返します。

        複数・索引付きメタ情報で、データが0個の場合はマイナス値を返します。 これについての詳細情報は BmsContent.metas() を参照してください。

        戻り値:
        インデックス値
      • getDefaultAsLong

        public final long getDefaultAsLong()
        メタ情報のデフォルト値をlong型で取得します。
        戻り値:
        メタ情報のデフォルト値のlong型表現
        例外:
        ClassCastException - メタ情報のデフォルト値をlong型に変換できない
        NullPointerException - 任意型メタ情報で当メソッドを実行した
      • getDefaultAsDouble

        public final double getDefaultAsDouble()
        メタ情報のデフォルト値をdouble型で取得します。
        戻り値:
        メタ情報のデフォルト値のdouble型表現
        例外:
        ClassCastException - メタ情報のデフォルト値をdouble型に変換できない
        NullPointerException - 任意型メタ情報で当メソッドを実行した
      • getDefaultAsString

        public final String getDefaultAsString()
        メタ情報のデフォルト値をString型で取得します。
        戻り値:
        メタ情報のデフォルト値のString型表現
      • getDefaultAsArray

        public final BmsArray getDefaultAsArray()
        メタ情報のデフォルト値をBmsArray型で取得します。
        戻り値:
        メタ情報のデフォルト値のBmsArray型表現
        例外:
        ClassCastException - メタ情報のデフォルト値をBmsArray型に変換できない
      • getDefault

        public final <T> T getDefault()
        メタ情報のデフォルト値を指定した型にキャストして取得します。

        当メソッドはデフォルト値を任意のデータ型にキャストして返します。

        型パラメータ:
        T - 任意のデータ型
        戻り値:
        メタ情報のデフォルト値
        例外:
        ClassCastException - メタ情報のデフォルト値を指定された任意のデータ型に変換できない
      • getValueAsLong

        public final long getValueAsLong()
        メタ情報の値をlong型で取得します。
        戻り値:
        メタ情報の値のlong型表現
        例外:
        ClassCastException - メタ情報の値をlong型に変換できない
      • getValueAsDouble

        public final double getValueAsDouble()
        メタ情報の値をdouble型で取得します。
        戻り値:
        メタ情報の値のdouble型表現
        例外:
        ClassCastException - メタ情報の値をdouble型に変換できない
      • getValueAsString

        public final String getValueAsString()
        メタ情報の値をString型で取得します。
        戻り値:
        メタ情報の値のString型表現
      • getValue

        public final <T> T getValue()
        メタ情報の値を指定した型にキャストして取得します。

        当メソッドは任意型メタ情報のデータを取得する際に利用してください。

        型パラメータ:
        T - 任意のデータ型
        戻り値:
        メタ情報の値。値が未設定の場合はメタ情報のデフォルト値。
        例外:
        ClassCastException - メタ情報の値を指定したデータ型に変換できない
      • isContain

        public final boolean isContain()
        このメタ情報にデータが設定されているかどうかを取得します。

        複数・索引付きメタ情報において、そのメタ情報が0個であることを示す(インデックスがマイナス値) の場合、当メソッドはfalseを返します。

        戻り値:
        このメタ情報にデータが設定されている場合true
      • isSingleUnit

        public final boolean isSingleUnit()
        このメタ情報が単体メタ情報かどうかを取得します。
        戻り値:
        単体メタ情報であればtrue
        関連項目:
        BmsMetaKey.isSingleUnit()
      • isMultipleUnit

        public final boolean isMultipleUnit()
        このメタ情報が複数メタ情報かどうかを取得します。
        戻り値:
        複数メタ情報であればtrue
        関連項目:
        BmsMetaKey.isMultipleUnit()
      • isIndexedUnit

        public final boolean isIndexedUnit()
        このメタ情報が索引付きメタ情報かどうかを取得します。
        戻り値:
        索引付きメタ情報であればtrue
        関連項目:
        BmsMetaKey.isIndexedUnit()
      • isIntegerType

        public final boolean isIntegerType()
        このメタ情報のデータ型が整数かどうかを取得します。
        戻り値:
        整数型であればtrue
        関連項目:
        BmsMeta.isIntegerType()
      • isFloatType

        public final boolean isFloatType()
        このメタ情報のデータ型が実数かどうかを取得します。
        戻り値:
        実数型であればtrue
        関連項目:
        BmsMeta.isFloatType()
      • isStringType

        public final boolean isStringType()
        このメタ情報のデータ型が文字列かどうかを取得します。
        戻り値:
        文字列型であればtrue
        関連項目:
        BmsMeta.isStringType()
      • isBase16Type

        public final boolean isBase16Type()
        このメタ情報のデータ型が16進数値かどうかを取得します。
        戻り値:
        16進数値型であればtrue
        関連項目:
        BmsMeta.isBase16Type()
      • isBase36Type

        public final boolean isBase36Type()
        このメタ情報のデータ型が36進数値かどうかを取得します。
        戻り値:
        36進数値型であればtrue
        関連項目:
        BmsMeta.isBase36Type()
      • isArray16Type

        public final boolean isArray16Type()
        このメタ情報のデータ型が16進数値配列かどうかを取得します。
        戻り値:
        16進数値配列型であればtrue
        関連項目:
        BmsMeta.isArray16Type()
      • isArray36Type

        public final boolean isArray36Type()
        このメタ情報のデータ型が36進数値配列かどうかを取得します。
        戻り値:
        36進数値配列型であればtrue
        関連項目:
        BmsMeta.isArray36Type()
      • isObjectType

        public final boolean isObjectType()
        このメタ情報のデータ型が任意型かどうかを取得します。
        戻り値:
        任意型であればtrue
        関連項目:
        BmsMeta.isObjectType()
      • isNumberType

        public final boolean isNumberType()
        このメタ情報のデータ型が数値型かどうかを取得します。
        戻り値:
        数値型であればtrue
        関連項目:
        BmsMeta.isNumberType()
      • isValueType

        public final boolean isValueType()
        このメタ情報のデータ型が値型かどうかを取得します。
        戻り値:
        値型であればtrue
        関連項目:
        BmsMeta.isValueType()
      • isArrayType

        public final boolean isArrayType()
        このメタ情報のデータ型が配列型かどうかを取得します。
        戻り値:
        配列型であればtrue
        関連項目:
        BmsMeta.isArrayType()
      • isNormalType

        public final boolean isNormalType()
        このメタ情報のデータ型が通常型かどうかを取得します。
        戻り値:
        通常型であればtrue
        関連項目:
        BmsMeta.isNormalType()