パッケージ io.realm
クラス RealmConfiguration
- java.lang.Object
-
- io.realm.RealmConfiguration
-
- 既知のサブクラスを直接:
SyncConfiguration
public class RealmConfiguration extends Object
RealmConfiguration は、特定の Realm インスタンスを設定するために使用されます。RealmConfiguration のインスタンスは、
RealmConfiguration.Builder
を使用し、そのRealmConfiguration.Builder.build()
メソッドを呼び出すことによってのみ作成できます。一般的に使用される RealmConfiguration は、最初に
Realm.setDefaultConfiguration(RealmConfiguration)
として保存し、次にRealm.getDefaultInstance()
を使用することで簡単にアクセスできます。最小構成は、以下を使用して作成できます。
RealmConfiguration config = new RealmConfiguration.Builder().build()
これにより、次のプロパティを持つ RealmConfiguration が作成されます。
- Realm ファイルの名前は "default.realm"
- Context.getFilesDir() に保存されている
- スキーマ バージョンは 0 に設定されています。
-
-
ネストされたクラスの概要
ネストされたクラス 修飾子と型 クラス 説明 static class
RealmConfiguration.Builder
RealmConfiguration.Builder は、RealmConfiguration のインスタンスをスムーズに構築するために使用されます。
-
フィールドの概要
フィールド 修飾子と型 フィールド 説明 static String
DEFAULT_REALM_NAME
-
メソッドの概要
すべてのメソッド インスタンス メソッド 具象メソッド 修飾子と型 方式 説明 boolean
equals(Object obj)
String
getAssetFilePath()
Realm アセット ファイルへのパスを返します。CompactOnLaunchCallback
getCompactOnLaunchCallback()
Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを判断するためのコールバックを返します。io.realm.internal.OsRealmConfig.Durability
getDurability()
byte[]
getEncryptionKey()
FlowFactory
getFlowFactory()
Realm オブジェクトから Kotlin フローを作成するために使用されるFlowFactory
を返します。long
getMaxNumberOfActiveVersions()
RealmMigration
getMigration()
String
getPath()
Realm ファイルが保存される場所への絶対パスを返します。File
getRealmDirectory()
String
getRealmFileName()
Set<Class<? extends RealmModel>>
getRealmObjectClasses()
この Realm のスキーマを構成するモデル クラスの変更不可のSet
を返します。RxObservableFactory
getRxFactory()
Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactory
を返します。long
getSchemaVersion()
boolean
hasAssetFile()
この構成用にアセット ファイルが構成されているかどうかを示します。int
hashCode()
boolean
isAllowQueriesOnUiThread()
UI スレッドからRealmQuery
を起動できるかどうかを返します。boolean
isAllowWritesOnUiThread()
Realm.executeTransaction(io.realm.Realm.Transaction)
への呼び出しを UI スレッドで実行できるかどうかを返します。boolean
isReadOnly()
この Realm が読み取り専用かどうかを返します。boolean
isRecoveryConfiguration()
boolean
shouldDeleteRealmIfMigrationNeeded()
String
toString()
-
-
-
メソッドの詳細
-
getRealmDirectory
publicファイルgetRealmDirectory()
-
getRealmFileName
public string getRealmFileName()
-
getEncryptionKey
public byte[] getEncryptionKey()
-
getSchemaVersion
public long getSchemaVersion()
-
getMigration
public RealmMigration getMigration()
-
ShouldDeleteRealmIfMigrationMoneded
公開ブール値 mustDeleteRealmIfMigrationMoneded()
-
getDurability
public io.realm.internal.OsRealmConfig.Durability getDurability()
-
hasAssetFile
公開ブール値 hasAssetFile()
この構成用にアセット ファイルが構成されているかどうかを示します。- 次の値を返します。
true
アセット ファイルがある場合は 、それ以外の場合はfalse
です。
-
getAssetFilePath
@Nullable public string getAssetFilePath()
Realm アセット ファイルへのパスを返します。- 次の値を返します。
- アセット ディレクトリを基準とするアセット ファイルへのパス、またはアセット ファイルが指定されていない場合は
null
。
-
getCompactOnLaunchコールバック
publicCompactOnLaunchCallback getCompactOnLauthCallback()
Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを判断するためのコールバックを返します。- 次の値を返します。
- プロセスの存在中に初めて Realm を開き、ユーザーに返される前に圧縮する必要があるかどうかを判断するために呼び出されるコールバック。 合計ファイルサイズ(データ + 空き領域)とファイル内のデータによって使用される合計バイト数が渡されます。
-
getRealmObjectClasses
public Set<Class<? extends RealmModel>> getRealmObjectClasses()
この Realm のスキーマを構成するモデル クラスの変更不可のSet
を返します。- 次の値を返します。
- モデル クラスの変更不可の
Set
。
-
getPath
public string getPath()
Realm ファイルが保存される場所への絶対パスを返します。- 次の値を返します。
- この構成で定義される Realm ファイルへの絶対パス。
-
getRxFactory
public RxObservableFactory getRxFactory()
Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactory
を返します。- 次の値を返します。
- Rx Observables を作成するために使用されるファクトリー インスタンス。
- 次の例外がスローされます。
UnsupportedOperationException
- 必要な RxJava フレームワークがクラスパスにない場合。
-
getFlowFactory
public FlowFactory getFlowFactory()
Realm オブジェクトから Kotlin フローを作成するために使用されるFlowFactory
を返します。- 次の値を返します。
- フローを作成するために使用されるファクトリー インスタンス。
- 次の例外がスローされます。
UnsupportedOperationException
- 必要なコルーチン フレームワークがクラスパスにない場合。
-
isReadOnly
公開ブール値 isReadOnly()
この Realm が読み取り専用かどうかを返します。 読み取り専用 Realm は変更できず、BaseRealm.beginTransaction()
が呼び出される場合はIllegalStateException
がスローされます。- 次の値を返します。
true
この Realm が読み取り専用である場合は 、読み取り専用である場合はfalse
。
-
isRecoveryConfiguration
公開ブール値 isRecoveryConfiguration()
- 次の値を返します。
true
この構成がバックアップ Realm(クライアントのリセットの結果として)を開くことを目的としている場合。
-
getMaxNumberOfActiveVersions
public long getMaxNumberOfActiveVersions()
- 次の値を返します。
- 例外がスローされる前に許可されるアクティブなバージョンの最大数。
-
isAllowWritesOnUiThread
公開ブール値 isAllowWritesOnUiThread()
Realm.executeTransaction(io.realm.Realm.Transaction)
への呼び出しを UI スレッドで実行できるかどうかを返します。注: Realm では、ユーザーが
RealmConfiguration.Builder.allowWritesOnUiThread(boolean)
またはその Realm Sync ビルダ カウンターを使用して明示的にオプトインしない限り、メイン スレッドでブロッキング トランザクションを実行することはできません。- 次の値を返します。
- UI スレッドから書込み (write) 操作の実行が許可されるかどうか。
-
isAllowQueriesOnUiThread
公開ブール値 isAllowQueriesOnUithread()
UI スレッドからRealmQuery
を起動できるかどうかを返します。デフォルトでは、Realm はメイン スレッドでのクエリを許可します。 これを無効にするには、ユーザーは
RealmConfiguration.Builder.allowQueriesOnUiThread(boolean)
またはその Realm Sync ビルダー カウンターを使用して明示的にオプトインする必要があります。- 次の値を返します。
- UI スレッドからクエリの実行を許可するかどうか。
-
-