パッケージ io.realm

インターフェース RealmCollection[E]<E>

  • 型パラメータ:
    E コレクションに保存されているRealmObjectの - タイプ。
    すべてのスーパーインターフェース:
    Collection<E>, io.realm.internal.Freezable<RealmCollection<E>>, Iterable<E>, io.realm.internal.ManageableObject
    すべての既知のサブインターフェース:
    OrderedRealmCollection<E>
    すべての既知の実装クラス:
    OrderedRealmCollectionSnapshot, RealmList, RealmResults, RealmSet
    public interface RealmCollection<E>
extends Collection<E>, io.realm.internal.ManageableObject, io.realm.internal.Freezable<RealmCollection<E>>
    RealmCollection は、Realm がサポートするコレクション階層のルートです。 データ コレクションに対する操作と、 RealmCollectionのすべての実装での操作の動作を定義します。

    Realm コレクションは、基礎となるデータに対する「ライブ」ビューです。 つまり、自動的に最新状態に保たれます。 最終的に、 Collections.unmodifiableCollection(Collection)のようなメソッドを使用してもコレクションの変更を妨げられることはありません。

    • メソッドの概要

      すべてのメソッド インスタンス メソッド 抽象メソッド 
      修飾子と型 方式 説明
      double average​(String fieldName)
      指定されたフィールドの平均を返します。
      boolean contains​(Object object)
      このCollectionに指定されたオブジェクトが含まれているかどうかをテストします。
      boolean deleteAllFromRealm()
      これにより、コレクション内のすべてのオブジェクトが基礎の Realm と コレクションから削除されます。
      boolean isLoaded()
      コレクションがデータのロードをまだ完了しているかどうかを確認します。
      boolean isManaged()
      コレクションが Realm によって管理されているかどうかを確認します。
      boolean isValid()
      コレクションがまだ使用可能かどうか、つまり、 Realmインスタンスが閉じられていないかどうかを確認します。
      boolean load()
      すべてのデータが利用可能になるまでコレクションをブロックします。
      Number max​(String fieldName)
      フィールドの最大値を検索します。
      Date maxDate​(String fieldName)
      最大日付を検索します。
      Number min​(String fieldName)
      フィールドの最小値を検索します。
      Date minDate​(String fieldName)
      最小日付を検索します。
      Number sum​(String fieldName)
      指定された フィールドの合計を計算します。
      RealmQuery<E> where()
      このコレクションの特定のオブジェクトに対するクエリに使用できるRealmQueryを返します。

      • インターフェースから継承されたメソッド

        freeze

      • インターフェース io.realm. internal.ManageableObject から継承されるメソッド

        isFrozen

    • メソッドの詳細

      • WHERE

        RealmQuery < E > where()
        このコレクションの特定のオブジェクトに対するクエリに使用できるRealmQueryを返します。
        次の値を返します。
        RealmQuery オブジェクト。
        次の例外がスローされます。
        IllegalStateException - Realm インスタンスが閉じられているか、クエリが利用できない場合。
        以下も参照してください。
        RealmQuery

      • min

        @Nullable
分数（ fieldNamestring ）
        フィールドの最小値を検索します。
        パラメーター:
        fieldName - 最小を検索するフィールド。 数値フィールドのみがサポートされます。
        次の値を返します。
        オブジェクトが存在しない場合、または特定のフィールドの値としてnullが含まれている場合は、 nullが返されます。 それ以外の場合は、最小値が返されます。 最小値を決定する場合、 null値を持つオブジェクトは無視されます。
        次の例外がスローされます。
        IllegalArgumentException - フィールドが数値型でない場合。
        IllegalStateException - Realm が閉じられているか、誤ったスレッドから呼び出された場合。

      • 最大

        @Nullable
Number max（ string fieldName）
        フィールドの最大値を検索します。
        パラメーター:
        fieldName - の最大値を検索するフィールド。 数値フィールドのみがサポートされます。
        次の値を返します。
        オブジェクトが存在しない場合、または特定のフィールドの値としてnullが含まれている場合は、 nullが返されます。 それ以外の場合は、最大値が返されます。 最大値を決定する際、 null値を持つオブジェクトは無視されます。
        次の例外がスローされます。
        IllegalArgumentException - フィールドが数値型でない場合。
        IllegalStateException - Realm が閉じられているか、誤ったスレッドから呼び出された場合。

      • 合計

        数値の合計（ string fieldName）
        指定された フィールドの合計を計算します。
        パラメーター:
        fieldName - 合計するフィールド。 数値フィールドのみがサポートされます。
        次の値を返します。
        の合計。 オブジェクトが存在しない場合、または指定されたフィールドの値としてnullが含まれている場合は、 0が返されます。 合計を計算する場合、 null値を持つオブジェクトは無視されます。
        次の例外がスローされます。
        IllegalArgumentException - フィールドが数値型でない場合。
        IllegalStateException - Realm が閉じられているか、誤ったスレッドから呼び出された場合。

      • 平均

        double平均（ string fieldName）
        指定されたフィールドの平均を返します。
        パラメーター:
        fieldName - 平均を計算するフィールド。 数値フィールドのみがサポートされます。
        次の値を返します。
        クエリ結果内のオブジェクト内の特定のフィールドの平均。 これは、すべての型の数値フィールドで double 型になります。 オブジェクトが存在しない場合、または指定されたフィールドの値としてnullが含まれている場合は、 0が返されます。 平均を計算する場合、 null値を持つオブジェクトは無視されます。
        次の例外がスローされます。
        IllegalArgumentException - フィールドが数値型でない場合。
        IllegalStateException - Realm が閉じられているか、誤ったスレッドから呼び出された場合。

      • 最大日付

        @Nullable
日付maxDate（ string fieldName）
        最大日付を検索します。
        パラメーター:
        fieldName - 最大日付を検索するフィールド。 fieldName が Date 型でない場合、例外がスローされます。
        次の値を返します。
        オブジェクトが存在しない場合、または特定の日付フィールドの値としてnullが含まれている場合は、 nullが返されます。 それ以外の場合は、最大日付が返されます。 最大日付を決定する際、 null値を持つオブジェクトは無視されます。
        次の例外がスローされます。
        IllegalArgumentException - fieldName が日付フィールドでない場合。
        IllegalStateException - Realm が閉じられているか、誤ったスレッドから呼び出された場合。

      • minDate

        @Nullable
日付minDate（ string fieldName）
        最小日付を検索します。
        パラメーター:
        fieldName - 最小日付を検索するフィールド。 fieldName が Date 型でない場合、例外がスローされます。
        次の値を返します。
        オブジェクトが存在しない場合、または特定の日付フィールドの値としてnullが含まれている場合は、 nullが返されます。 それ以外の場合は、最小日付が返されます。 最小日付を決定する場合、 null値を持つオブジェクトは無視されます。
        次の例外がスローされます。
        IllegalArgumentException - fieldName が日付フィールドでない場合。
        IllegalStateException - Realm が閉じられているか、誤ったスレッドから呼び出された場合。

      • deleteAllFromRealm

        ブール値の deleteAllFromRealm()
        これにより、コレクション内のすべてのオブジェクトが基礎の Realm と コレクションから削除されます。
        次の値を返します。
        true オブジェクトが削除された場合は 、それ以外の場合はfalse 。
        次の例外がスローされます。
        IllegalStateException - 対応する Realm が閉じているか、誤ったスレッドにある場合。
        IllegalStateException - Realm が閉じられているか、誤ったスレッドから呼び出された場合。

      • isLoaded

        ブール値 isLoaded()
        コレクションがデータのロードをまだ完了しているかどうかを確認します。
        次の値を返します。
        true データがロードされ、利用可能な場合は 、データがまだロード中の場合はfalseになります。

      • 負荷

        ブール値（）
        すべてのデータが利用可能になるまでコレクションをブロックします。
        次の値を返します。
        true データを正常に読み込むことができた場合は 、そうでない場合はfalse 。

      • isValid

        ブール値 isValid()
        コレクションがまだ使用可能かどうか、つまり、 Realmインスタンスが閉じられていないかどうかを確認します。 管理されていないコレクションでは常にtrueが返されます。
        次のによって指定されます。
        isValid 内 インターフェース io.realm.internal.ManageableObject
        次の値を返します。
        true または管理されていないコレクションを使用するためにまだ有効な場合は 、それ以外の場合はfalseです。

      • isManaged

        ブール値 isManaged()
        コレクションが Realm によって管理されているかどうかを確認します。 マネージド コレクションは、基礎となる Realm ファイル内のデータを囲むラッパーに相当します。 ルーパー スレッドでは、管理対象のコレクションがライブアップデートされるため、常に最新データを参照します。 管理されたコレクションはスレッド制限されており、それを作成したコレクション以外のスレッドからはアクセスできません。

        このメソッドがfalseを返す場合、コレクションは管理されていません。 管理されていないコレクションは通常の Java コレクションであるため、ライブ更新はされません。

        次のによって指定されます。
        isManaged 内 インターフェース io.realm.internal.ManageableObject
        次の値を返します。
        true これが管理対象のRealmCollectionである場合は 、それ以外の場合はfalseです。

      • に含まれる

        ブール値に が含まれます（ @Nullable Object object）
        このCollectionに指定されたオブジェクトが含まれているかどうかをテストします。 このCollection内の少なくとも 1 つの要素elemが次の要件を満たす場合にのみtrueが返されます: (object==null ? elem==null : object.equals(elem)) 。
        次のによって指定されます。
        contains 内 インターフェース Collection<E>
        パラメーター:
        object - 検索するオブジェクト。
        次の値を返します。
        true オブジェクトがこのCollectionの要素である場合は 、それ以外の場合はfalseです。
        次の例外がスローされます。
        NullPointerException - 検索するオブジェクトがnullで、このCollectionがnull要素をサポートしていない場合。