クラス RealmObject
項目一覧
io.realm
実装されたインターフェース:
Realm では、RealmObject をサブクラス化し、永続化するフィールドを追加することで RealmObject クラスを定義します。 次に、Realm 内でオブジェクトを作成し、RealmObject クラスを直接使用する代わりにカスタム サブクラスを使用します。注釈プロセッサは、RealmObject サブクラスのプロキシ クラスを作成します。
次のフィールド データ型がサポートされています。
ブール値/ブール値
短い/短い
int/Integer
long/Long
float/Float
double / double
byte[]
文字列
日付
UUID
org.bson.types.Decimal128
org.bson.types.ObjectId
任意の RealmObject サブクラス
RealmList
RealmDictionary
short
、 int
、 long
の各タイプは、Realm 内に保存するときにlong
にマッピングされます。
RealmObject に課されている唯一の制限事項は、フィールドが最終的または変動的であることは許可されていないことです。 パブリック フィールドと任意のメソッドが許可されます。 カスタム コンストラクターを提供する場合、引数のないパブリック コンストラクターを宣言する必要があります。
io.realm.annotations.Ignoreで注釈が付けられたフィールドにはこれらの制限はなく、ゲッターもセッターも必要ありません。
Realm は、 io.realm.annotations.Indexで注釈が付けられたフィールドのインデックスを作成します。 これによりクエリは高速化されますが、挿入と更新には悪影響が生じます。
RealmObject を異なるスレッド間で渡すことはできません。
コンストラクター
コンストラクターと説明 |
---|
RealmObject () |
メソッドの概要
修飾子と型 | メソッドと説明 |
---|---|
public static void | 値フィールドまたは参照された RealmObject フィールドが変更された場合、または RealmList フィールド自体が変更された場合にトリガーされる変更リスナーを RealmObject に追加します。 |
public static void | RealmObject に 変更リスナー を追加して、変更に関する詳細情報を取得します。 |
public final void | この RealmObject に、値フィールドまたは参照先の RealmObject フィールドが変更された場合、または RealmList フィールド自体が変更された場合にトリガーされる 変更リスナー を追加します。 |
public final void | この RealmObject に 変更リスナー を追加して、変更に関する詳細情報を取得します。 |
public static <any> | この RealmObject への変更を監視する Rx Observable を返します。 |
public final <any> | asChangesetObservable <E >() この RealmObject への変更を監視する Rx Observable を返します。 |
public static <any> | この RealmObject への変更を監視する RxJava フロー可能を返します。 |
public final <any> | asFlowable <E >() この RealmObject への変更を監視する RxJava フロー可能を返します。 |
public static void | 現在関連付けられている Realm からオブジェクトを削除します。 |
public final void | 現在関連付けられている Realm からオブジェクトを削除します。 |
public static E | このオブジェクトの固定スナップショットを返します。 |
public final E | freeze <E >() このオブジェクトの固定スナップショットを返します。 |
public static Realm | は、 |
public Realm | getRealm () この RealmObject が属する Realm インスタンスを返します。 |
public static boolean | この RealmObject が固定されているかどうかを返します。 |
public final boolean | isFrozen () この RealmObject が固定されているかどうかを返します。 |
public static boolean | この RealmObject を検索するために使用されるクエリが完了しているかどうかを確認します。 |
public final boolean | isLoaded () この RealmObject を検索するために使用されるクエリが完了しているかどうかを確認します。 |
public static boolean | このオブジェクトが Realm によって管理されているかどうかを確認します。 |
パブリックブール値 | isManaged () このオブジェクトが Realm によって管理されているかどうかを確認します。 |
public static boolean | RealmObject がまだ を使用するために有効であるかどうか、つまり RealmObject が削除されておらず、 io.realm.Realmが閉じられていないことを確認します。 |
public final boolean | isValid () RealmObject がまだ を使用するために有効であるかどうか、つまり RealmObject が削除されておらず、 io.realm.Realmが閉じられていないことを確認します。 |
public static boolean | 非同期クエリをブロック化します。 |
public final boolean | load () 非同期クエリをブロック化します。 |
public static void | 指定された RealmObject から登録されたすべてのリスナーを削除します。 |
public final void | 登録されたすべてのリスナーを削除します。 |
public static void | 指定された RealmObject に以前に登録されたリスナーを削除します。 |
public static void | 指定された RealmObject に以前に登録されたリスナーを削除します。 |
public final void | 以前に登録されたリスナーを削除します。 |
public final void | 以前に登録されたリスナーを削除します。 |
継承されたメソッド
クラス java.lang.Object から継承されたメソッド :
getClass
、hashCode
、equals
、clone
、toString
、notify
、notifyAll
、wait
、wait
、wait
、finalize
コンストラクターの詳細
public RealmObject () |
---|
メソッドの詳細
addchangeLister
値フィールドまたは参照された RealmObject フィールドが変更された場合、または RealmList フィールド自体が変更された場合にトリガーされる 変更リスナー を RealmObject に追加します。変更リスナーを登録しても、基礎となる RealmObject がガベージ コレクションされるのを妨げるものではありません。 RealmObject がガベージ コレクションされると、変更リスナーはトリガーされなくなります。 これを回避するには、クラス変数内で適切な例がある限り、強力な参照を保持します。
パラメーター
スロー
|
RealmObject に 変更リスナー を追加して、変更に関する詳細情報を取得します。 リスナーは、値フィールドもしくは参照された RealmObject フィールドが変更された場合、または RealmList フィールド自体が変更された場合にトリガーされます。変更リスナーを登録しても、基礎となる RealmObject がガベージ コレクションされるのを妨げるものではありません。 RealmObject がガベージ コレクションされると、変更リスナーはトリガーされなくなります。 これを回避するには、クラス変数内で適切な例がある限り、強力な参照を保持します。
パラメーター
スロー
|
この Realm。 RealmObject がガベージ コレクションされると、変更リスナーはトリガーされなくなります。 これを回避するには、クラス変数内で適切な例がある限り、強力な参照を保持します。
パラメーター
スロー
|
この RealmObject に 変更リスナー を追加して、変更に関する詳細情報を取得します。 リスナーは、値フィールドもしくは参照された RealmObject フィールドが変更された場合、または RealmList フィールド自体が変更された場合にトリガーされます。変更リスナーを登録しても、基礎となる RealmObject がガベージ コレクションされるのを妨げるものではありません。 RealmObject がガベージ コレクションされると、変更リスナーはトリガーされなくなります。 これを回避するには、クラス変数内で適切な例がある限り、強力な参照を保持します。
パラメーター
スロー
|
as変更セットObservable
この RealmObject への変更を監視する Rx Observable を返します。 サブスクライブすると、現在の RealmObject が発行されます。 RealmObject への更新ごとに、 RealmObjectと Object ChangeSet で構成されるペアが送信されます。 RealmObject が初めて発行されるときに、変更セットは RealmObject は更新されるたびに継続的に出力されます。 Realm Observable から発行されたアイテムは固定されます( Releases()を参照してください。 つまり、これらは不変で、どのスレッドでも読み取ることができます。 Realm Observable は、ライブ Realm を保持するスレッドから常にアイテムを出力します。 つまり、追加の処理が必要な場合は、計算スケジューラーで の値を確認することをお勧めします。
パラメーター
戻り値 RxJava Observable は スロー
|
public final <any> asChangesetObservable <E >() | |||||
---|---|---|---|---|---|
この RealmObject への変更を監視する Rx Observable を返します。 サブスクライブすると、現在の RealmObject が発行されます。 RealmObject への更新ごとに、 RealmObjectと Object ChangeSet で構成されるペアが送信されます。 RealmObject が初めて発行されるときに、変更セットは RealmObject は更新されるたびに継続的に出力されます。 Realm Observable から発行されたアイテムは固定されます( Releases()を参照してください。 つまり、これらは不変で、どのスレッドでも読み取ることができます。 Realm Observable は、ライブ Realm を保持するスレッドから常にアイテムを出力します。 つまり、追加の処理が必要な場合は、計算スケジューラーで の値を確認することをお勧めします。
戻り値 RxJava Observable は スロー
|
asFlowable
この RealmObject への変更を監視する RxJava フロー可能を返します。 サブスクライブすると、現在のオブジェクトが発行されます。 RealmObject が更新されると、オブジェクトの更新が継続的に発行されます - RealmObject Observable を連鎖させる場合、 Realm フロー可能な から出力されたアイテムは固定されます( Releases ()を参照してください。 つまり、これらは不変で、どのスレッドでも読み取ることができます。 Realm フロー接続は、ライブ Realm を保持するスレッドから常にアイテムを出力します。 つまり、追加の処理が必要な場合は、計算スケジューラーで の値を確認することをお勧めします。
パラメーター
戻り値 RxJava Observable は スロー
|
public final <any> asFlowable <E >() | |||||||||
---|---|---|---|---|---|---|---|---|---|
この RealmObject への変更を監視する RxJava フロー可能を返します。 サブスクライブすると、現在のオブジェクトが発行されます。 RealmObject が更新されると、オブジェクトの更新が継続的に発行されます - RealmObject フローを連鎖させる場合、 Realm フロー可能な から出力されたアイテムは固定されます( Releases ()を参照してください。 つまり、これらは不変で、どのスレッドでも読み取ることができます。 Realm フロー接続は、ライブ Realm を保持するスレッドから常にアイテムを出力します。 つまり、追加の処理が必要な場合は、計算スケジューラーで の値を確認することをお勧めします。
型パラメータ
戻り値 RxJava Observable は スロー
|
deleteFromRealm
現在関連付けられている Realm からオブジェクトを削除します。このメソッドが呼び出されると、オブジェクトは無効になり、そのオブジェクトで実行されたすべての操作(読み取りまたは書込み)は IllealStateException で失敗します。 スロー
|
public final void deleteFromRealm () |
---|
現在関連付けられている Realm からオブジェクトを削除します。このメソッドが呼び出されると、オブジェクトは無効になり、そのオブジェクトで実行されたすべての操作(読み取りまたは書込み)は IllealStateException で失敗します。 スロー
|
freeze
このオブジェクトの固定スナップショットを返します。 固定されたコピーは、 IllialStateException をスローすることなく、任意のスレッドから読み取りとクエリが可能 。 RealmObject を固定すると、独自のライフサイクルを持つ固定 Realm も作成されますが、元のコレクションを生成したライブ Realm が完全に閉じている場合(つまり 全スレッドにわたるすべての インスタンスが閉じられます)。固定された Realm と オブジェクトも閉じられます。 凍結されたオブジェクトは通常どおりクエリできますが、それを何らかの方法で変更しようとしたり、リスナーを登録しようとすると、 IllealStateException がスローされます 。 注: 異なるバージョンを持つ多数の固定オブジェクトを有効にすると、Realm のファイルサイズに悪影響が及ぶ可能性があります。 このような状況を回避するには、 RealmConfiguration.Builder.maxNumberOfActiveVersions(long)を設定します。 戻り値 このオブジェクトの固定されたコピー。 スロー
|
public final E freeze <E >() |
---|
このオブジェクトの固定スナップショットを返します。 固定されたコピーは、 IllialStateException をスローすることなく、任意のスレッドから読み取りとクエリが可能 。 RealmObject を固定すると、独自のライフサイクルを持つ固定 Realm も作成されますが、元のコレクションを生成したライブ Realm が完全に閉じている場合(つまり 全スレッドにわたるすべての インスタンスが閉じられます)。固定された Realm と オブジェクトも閉じられます。 凍結されたオブジェクトは通常どおりクエリできますが、それを何らかの方法で変更しようとしたり、リスナーを登録しようとすると、 IllealStateException がスローされます 。 注: 異なるバージョンを持つ多数の固定オブジェクトを有効にすると、Realm のファイルサイズに悪影響が及ぶ可能性があります。 このような状況を回避するには、 RealmConfiguration.Builder.maxNumberOfActiveVersions(long)を設定します。 戻り値 このオブジェクトの固定されたコピー。 スロー
|
getRealm
は、 Realm.close()は呼び出しないでください。 返されたインスタンスに対して。 パラメーター
戻り値
スロー
|
この RealmObject が属する Realm インスタンスを返します。 Realm.close()は呼び出しないでください。 返されたインスタンスに対して。 戻り値 このオブジェクトが属するRealmインスタンス、またはこのオブジェクトが管理されていない場合は スロー
|
IsFrozen
この RealmObject が固定されているかどうかを返します。 戻り値
|
isLoaded
この RealmObject を検索するために使用されたクエリが完了しているかどうかを確認します。 RealmQuery.findFirstAsync() などの非同期メソッドは、 RealmQuery の将来の結果を表す RealmObject を返します。java.uty.concurrent.feature は、 この点では 。
「Null」オブジェクトは
同期 RealmObject は定義上、このメソッドはそれらに対して常に パラメーター
戻り値
|
public final boolean isLoaded () | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
この RealmObject を検索するために使用されたクエリが完了しているかどうかを確認します。 RealmQuery.findFirstAsync() などの非同期メソッドは、 RealmQuery の将来の結果を表す RealmObject を返します。java.uty.concurrent.feature は、 この点では 。
「Null」オブジェクトは
同期 RealmObject は定義上、このメソッドはそれらに対して常に 戻り値
|
isManaged
このオブジェクトが Realm によって管理されているかどうかを確認します。 管理対象オブジェクトは、基礎となる Realm ファイル内のデータを囲むラッパーに相当します。 ルーパー スレッドでは、管理対象のオブジェクトがライブアップデートされるため、常に最新データを参照します。 addCheckLister(RealmModel, RealmchangeLister)を使用して変更リスナーを登録し、変更が発生したときに通知を受けることができます。 管理されたオブジェクトはスレッド制限され、作成されたオブジェクト以外の他のスレッドからはアクセスできません。 このメソッドが Realm. copyToRealm(RealmModel, ImportFlag...)を使用して、管理されていないオブジェクトから管理されたオブジェクトを作成することができます。 Realm. copyFromRealm(RealmModel)を使用して、管理対象オブジェクトから管理されていないオブジェクトを作成できます。 戻り値
|
public boolean isManaged () |
---|
このオブジェクトが Realm によって管理されているかどうかを確認します。 管理対象オブジェクトは、基礎となる Realm ファイル内のデータを囲むラッパーに相当します。 ルーパー スレッドでは、管理対象のオブジェクトがライブアップデートされるため、常に最新データを参照します。 addCheckLister(RealmchangeLister)を使用して変更リスナーを登録し、変更が発生したときに通知を受けることができます。 管理されたオブジェクトはスレッド制限され、作成されたオブジェクト以外の他のスレッドからはアクセスできません。 このメソッドが Realm. copyToRealm(RealmModel, ImportFlag...)を使用して、管理されていないオブジェクトから管理されたオブジェクトを作成することができます。 Realm. copyFromRealm(RealmModel)を使用して、管理対象オブジェクトから管理されていないオブジェクトを作成できます。 戻り値
|
isValid
RealmObject がまだ を使用するために有効であるかどうか、つまり RealmObject が削除されておらず、 io.realm.Realmが閉じられていないことを確認します。 管理されていないオブジェクトでは常に パラメーター
戻り値
|
public final boolean isValid () | |||
---|---|---|---|
RealmObject がまだ を使用するために有効であるかどうか、つまり RealmObject が削除されておらず、 io.realm.Realmが閉じられていないことを確認します。 管理されていないオブジェクトでは常に これは、観察された場合に
戻り値
|
負荷
非同期クエリをブロック化します。 これにより、登録されているリスナーも trigger されます。注意: これは、アンマネージドオブジェクト(Realmの外部で作成されたオブジェクト)に対して呼び出された場合、 パラメーター
戻り値
|
public final boolean load () |
---|
非同期クエリをブロック化します。 これにより、登録されているリスナーも trigger されます。注意: これは、アンマネージドオブジェクト(Realmの外部で作成されたオブジェクト)に対して呼び出された場合、 戻り値
|
deleteAllTimeListers
指定された RealmObject から登録されたすべてのリスナーを削除します。 パラメーター
スロー
|
public final void removeAllChangeListeners () |
---|
登録されたすべてのリスナーを削除します。 |
deleteCheckLister
指定された RealmObject に以前に登録されたリスナーを削除します。 パラメーター
スロー
|
指定された RealmObject に以前に登録されたリスナーを削除します。 パラメーター
スロー
|
以前に登録されたリスナーを削除します。 パラメーター
スロー
|
以前に登録されたリスナーを削除します。 パラメーター
スロー
|