Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDK
/
Java SDK
/
API リファレンス
/
io.realm

クラス RealmConfiguration

項目一覧

  • io.realm
  • ネストされたクラスの概要
  • フィールドの概要
  • メソッドの概要
  • 継承されたメソッド
  • フィールドの詳細
  • DEFAULT_REALM_NAME
  • メソッドの詳細
  • createSchemaMedator
  • equals
  • forRecovery
  • getAssetFilePath
  • getCompactOnLaunchコールバック
  • getDurability
  • getEncryptionKey
  • getFlowFactory
  • getInitialDataTransaction
  • getInstance
  • getMaxNumberOfActiveVersions
  • getMigration
  • getPath
  • getRealmDirectory
  • getRealmFileName
  • getRealmObjectClasses
  • getRxFactory
  • getSchemaMedator
  • getSchemaVersion
  • hasAssetFile
  • ハッシュコード
  • isAllowQueriesOnUiThread
  • isAllowWritesOnUiThread
  • isReadOnly
  • isRecoveryConfiguration
  • isSyncConfiguration
  • RealmExists
  • ShouldDeleteRealmIfMigrationMoneded
  • toString

io.realm

java.lang.Object
io.realm.RealmConfiguration

RealmConfiguration は、特定の Realm インスタンスを設定するために使用されます。RealmConfiguration のインスタンスは、 io.realm.RealmConfiguration.Builderを使用し、そのio.realm.RealmConfiguration.Builder.build()を呼び出すことによってのみ作成できます。 使用して複数のドキュメントを挿入できます。

よく使用される RealmConfiguration は、まずRealm.setDefaultConfiguration(RealmConfiguration)として保存することで簡単にアクセスできます。 io.realm.Realm.getDefaultInstance()を使用します。

最小構成は、以下を使用して作成できます。

RealmConfiguration config = new RealmConfiguration.Builder().build()

これにより、次のプロパティを持つ RealmConfiguration が作成されます。

  • Realm ファイルの名前は "default.realm"

  • Context.getFilesDir() に保存されている

  • スキーマ バージョンは 0 に設定されています。

ネストされたクラスの概要

修飾子と型
クラスと説明
public static

フィールドの概要

修飾子と型
フィールドと説明
public static final String

メソッドの概要

修飾子と型
メソッドと説明
保護された静的RealmProxyMedator
パブリックブール値
保護された静的RealmConfiguration
forRecovery (
String canonicalPath,
byte[] encryptionKey,
RealmProxyMediator schemaMediator
)
public string
getAssetFilePath ()

Realm アセット ファイルへのパスを返します。

getCompactOnLaunchCallback ()

Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを判断するためのコールバックを返します。

public OpsRealmConfig.Durability
公開バイト
getFlowFactory ()

Realm オブジェクトから Kotlin フローを作成するために使用されるFlowFactoryを返します。

保護されたRealm.Transaction
getInitialDataTransaction ()

初期データを含むトランザクションインスタンスを返します。

保護されたRealm
getInstance (
OsSharedRealm.VersionID version
)
public long
public string
getPath ()

Realm ファイルが保存される場所への絶対パスを返します。

public string
public Set
getRealmObjectClasses ()

変更不可の セットを 返します この Realm のスキーマを構成するモデル クラスの 。

getRxFactory ()

Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactoryを返します。

保護されたRealmProxyMedator
getSchemaMediator ()

この構成によって定義されているスキーマのメトリクスを返します。

public long
パブリックブール値
hasAssetFile ()

この構成用にアセット ファイルが構成されているかどうかを示します。

public int
パブリックブール値
isAllowQueriesOnUiThread ()

RealmQueryが UI スレッドからの起動を許可するかどうかを返します。

パブリックブール値
isAllowWritesOnUiThread ()

Realm.executeTransactionへの呼び出しを UI スレッドで実行できるかどうかを返します。

パブリックブール値
isReadOnly ()

この Realm が読み取り専用かどうかを返します。

パブリックブール値
保護されたブール値
保護されたブール値
realmExists ()

この構成で定義された Realm ファイルがすでに存在するかどうかを確認します。

パブリックブール値
public string

継承されたメソッド

  • クラス java.lang.Object から継承されたメソッド :getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

フィールドの詳細

DEFAULT_REALM_NAME

メソッドの詳細

createSchemaMedator

protected static RealmProxyMediator createSchemaMediator (
java.util.Set<java.lang.Object> modules,
java.util.Set<java.lang.Class<? extends io.realm.RealmModel>> debugSchema,
boolean excludeDebugSchema
)

equals

public boolean equals (
Object obj
)

forRecovery

protected static RealmConfiguration forRecovery (
String canonicalPath,
byte[] encryptionKey,
RealmProxyMediator schemaMediator
)

getAssetFilePath

Realm アセット ファイルへのパスを返します。

戻り値

アセット ディレクトリを基準とするアセット ファイルへのパス、またはアセット ファイルが指定されていない場合はnull 。

getCompactOnLaunchコールバック

Realm ファイルをユーザーに返す前に圧縮する必要があるかどうかを判断するためのコールバックを返します。

戻り値

プロセスの存在中に初めて Realm を開き、ユーザーに返される前に圧縮する必要があるかどうかを判断するために呼び出されるコールバック。 合計ファイルサイズ（データ + 空き領域）とファイル内のデータによって使用される合計バイト数が渡されます。

getDurability

public OsRealmConfig.Durability getDurability ()

getEncryptionKey

public byte getEncryptionKey ()

getFlowFactory

Realm オブジェクトから Kotlin フローを作成するために使用されるFlowFactoryを返します。

戻り値

フローを作成するために使用されるファクトリー インスタンス。

スロー

getInitialDataTransaction

初期データを含むトランザクションインスタンスを返します。

戻り値

最初のデータトランザクション。

getInstance

protected Realm getInstance (
OsSharedRealm.VersionID version
)

getMaxNumberOfActiveVersions

戻り値

例外がスローされる前に許可されるアクティブなバージョンの最大数。

getMigration

getPath

public String getPath ()

Realm ファイルが保存される場所への絶対パスを返します。

戻り値

この構成で定義される Realm ファイルへの絶対パス。

getRealmDirectory

getRealmFileName

getRealmObjectClasses

変更不可の セットを 返します この Realm のスキーマを構成するモデル クラスの 。

戻り値

変更不可の セット のモデル クラスの

getRxFactory

Realm オブジェクトから Rx Observable を作成するために使用されるRxObservableFactoryを返します。

戻り値

Rx Observables を作成するために使用されるファクトリー インスタンス。

スロー

getSchemaMedator

protected RealmProxyMediator getSchemaMediator ()

この構成によって定義されているスキーマのメトリクスを返します。

戻り値

スキーマのメトリクス。

getSchemaVersion

public long getSchemaVersion ()

hasAssetFile

public boolean hasAssetFile ()

この構成用にアセット ファイルが構成されているかどうかを示します。

戻り値

true アセット ファイルがある場合は 、それ以外の場合はfalseです。

ハッシュコード

public int hashCode ()

isAllowQueriesOnUiThread

public boolean isAllowQueriesOnUiThread ()

RealmQueryが UI スレッドからの起動を許可するかどうかを返します。

デフォルトでは、Realm はメイン スレッドでのクエリを許可します。 これを無効にするには、ユーザーはBuilder.allowQueriesOnUiThread(ブール値)またはその Realm Sync ビルダのカウンター を使用して明示的にオプトインする必要があります。

戻り値

UI スレッドからクエリの実行を許可するかどうか。

isAllowWritesOnUiThread

public boolean isAllowWritesOnUiThread ()

Realm.executeTransactionへの呼び出しを UI スレッドで実行できるかどうかを返します。

注：Realm では、ユーザーがBuilder.allowWritesOnUiThread(ブール値)またはその Realm Sync ビルダ カウンターポートで明示的にオプトインしない限り、メイン スレッドでブロッキング トランザクションを実行することはできません。

戻り値

UI スレッドから書込み (write) 操作の実行が許可されるかどうか。

isReadOnly

public boolean isReadOnly ()

この Realm が読み取り専用かどうかを返します。 読み取り専用 Realm は変更できず、 IllealStateException がスローされます Realm.beginTransaction() が呼び出される場合。

戻り値

true この Realm が読み取り専用である場合は 、読み取り専用である場合はfalse 。

isRecoveryConfiguration

public boolean isRecoveryConfiguration ()

戻り値

true この構成がバックアップ Realm（クライアントのリセットの結果として）を開くことを目的としている場合。

Tip

以下も参照してください。

  • {@link ClientResetRequiredError}

isSyncConfiguration

protected boolean isSyncConfiguration ()

RealmExists

protected boolean realmExists ()

この構成で定義された Realm ファイルがすでに存在するかどうかを確認します。WARNING: この方法は、単純にポイントインタイムチェックです。 外部同期によって保護されていない限り、このメソッドが返された直後に、別のスレッドまたはプロセスによって Realm ファイルが作成または削除された可能性があります。

戻り値

true Realm ファイルが存在する場合は 、それ以外の場合はfalseです。

ShouldDeleteRealmIfMigrationMoneded

toString

public String toString ()

戻る

RealmCollection

次へ

RealmConfiguration.Builder