安装包 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。可以使用以下方法创建最小配置:
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
-
方法摘要
-
-
-
方法详细信息
-
getRealmDirectory
public File getRealmDirectory()
-
getRealmFileName
public String getRealmFileName()
-
getEncryptionKey
公共字节 [] getEncryptionKey ()
-
getSchemaVersion
public long getSchemaVersion()
-
getMigration
public RealmMigration getMigration()
-
shouldDeleteRealmIfMigrationNeeded
公共布尔shouldDeleteRealmIfMigrationNeeded()
-
getDurability
public io.realm.internal.OsRealmConfig.Durability getDurability()
-
hasAssetFile
public boolean hasAssetFile()
指示是否已为此配置配置资产文件。- 返回:
true
如果存在资产文件,则为false
。
-
getAssetFilePath
@Nullable public String getAssetFilePath()
返回 Realm 资产文件的路径。- 返回:
- 相对于资产目录的资产文件路径,如果未指定资产文件,则为
null
。
-
getCompactOnLaunchCallback
public CompactOnLaunchCallback getCompactOnLaunchCallback()
返回回调,以确定在将 Realm 文件返回给用户之前是否应进行压缩。- 返回:
- 在进程生命周期中首次打开 Realm 时调用的回调,以确定在将其返回给用户之前是否应进行压缩。 系统会向其传递总文件大小(数据 + 可用空间)以及文件中数据使用的总字节数。
-
getRealmObjectClasses
public Set<Class<? extends RealmModel>> getRealmObjectClasses()
返回构成此 Realm 模式的模型类的不可修改的Set
。- 返回:
- 模型类的不可修改的
Set
。
-
getPath
public String getPath()
返回 Realm 文件保存位置的绝对路径。- 返回:
- 此配置定义的 Realm 文件的绝对路径。
-
getRxFactory
public RxObservableFactory getRxFactory()
返回用于从 Realm 对象创建 Rx Observables 的RxObservableFactory
。- 返回:
- 用于创建 Rx Observables 的工厂实例。
- 抛出异常:
UnsupportedOperationException
- 如果所需的 RxJava 框架不在类路径中。
-
getFlowFactory
public FlowFactory getFlowFactory()
返回用于从 Realm 对象创建 Kotlin 流的FlowFactory
。- 返回:
- 用于创建流的工厂实例。
- 抛出异常:
UnsupportedOperationException
- 如果所需的协程框架不在类路径中。
-
isReadOnly
public boolean isReadOnly()
返回此 Realm 是否为只读。 只读 Realm 无法修改,如果对其调用BaseRealm.beginTransaction()
,则会抛出IllegalStateException
。- 返回:
true
如果此 Realm 为只读,则返回false
。
-
isRecoveryConfiguration
public boolean isRecoveryConfiguration()
- 返回:
true
如果此配置旨在打开备份 Realm(由于客户端重置)。
-
getMaxNumberOfActiveVersions
public long getMaxNumberOfActiveVersions()
- 返回:
- 抛出异常之前允许的最大活动版本数。
-
isAllowWritesOnUiThread
public boolean isAllowWritesOnUiThread()
返回是否可以在用户界面线程上完成对Realm.executeTransaction(io.realm.Realm.Transaction)
的调用。注意:除非用户明确选择使用
RealmConfiguration.Builder.allowWritesOnUiThread(boolean)
或其 Realm Sync 构建器对应项,否则 Realm 不允许在主线程上运行阻塞事务。- 返回:
- 是否允许从用户界面线程运行写入操作。
-
isAllowQueriesOnUiThread
public boolean isAllowQueriesOnUiThread()
返回是否允许从用户界面线程启动RealmQuery
。默认情况下,Realm 允许在主线程上进行查询。 要禁止此行为,用户必须使用
RealmConfiguration.Builder.allowQueriesOnUiThread(boolean)
或其 Realm Sync 构建器对应项明确选择加入。- 返回:
- 是否允许从用户界面线程运行查询。
-
-