鸿蒙OS StoreConfig.Builder

StoreConfig.Builder

java.lang.Object

|---ohos.data.rdb.StoreConfig.Builder

public static final class StoreConfig.Builder
extends Object

表示 StoreConfig 的构建器。

构造函数摘要

构造函数	描述
Builder()	Builder 实例的默认构造函数。
Builder(StoreConfig storeConfig)	用于创建具有指定 StoreConfig 对象的 Builder 实例的构造函数。

方法总结

修饰符和类型	方法	描述
StoreConfig	build()	使用具有指定配置的构建器创建 StoreConfig 实例。
StoreConfig.Builder	setDatabaseFileSecurityLevel(DatabaseFileSecurityLevel databaseFileSecurityLevel)	为数据库文件设置指定的安全级别。
StoreConfig.Builder	setDatabaseFileType(DatabaseFileType databaseFileType)	设置 StoreConfig 对象的数据库文件类型。
StoreConfig.Builder	setEncryptKey(byte[] encryptKey)	设置 StoreConfig 对象的加密密钥。
StoreConfig.Builder	setJournalMode(StoreConfig.JournalMode journalMode)	设置 StoreConfig 对象的日志模式。
StoreConfig.Builder	setName(String name)	设置 StoreConfig 对象的名称。
StoreConfig.Builder	setReadOnly(boolean isReadOnly)	设置数据库是否为只读。
StoreConfig.Builder	setStorageMode(StoreConfig.StorageMode storageMode)	设置 StoreConfig 对象的存储模式。
StoreConfig.Builder	setSyncMode(StoreConfig.SyncMode syncMode)	设置 StoreConfig 对象的同步模式。

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造函数详细信息

Builder

public Builder()

Builder 实例的默认构造函数。

Builder

public Builder(StoreConfig storeConfig)

用于创建具有指定 StoreConfig 对象的 Builder 实例的构造函数。

参数：

参数名称	参数描述
storeConfig	指示用于创建 Builder 实例的 StoreConfig 对象。

方法详情

setName

public StoreConfig.Builder setName(String name)

设置 StoreConfig 对象的名称。

参数：

参数名称	参数描述
name	指示要设置的数据库名称。

返回:

返回用于创建具有指定数据库名称的 StoreConfig 的 Builder 实例。

setStorageMode

public StoreConfig.Builder setStorageMode(StoreConfig.StorageMode storageMode)

设置 StoreConfig 对象的存储模式。

参数：

参数名称	参数描述
storageMode	表示要设置的存储模式。

返回:

返回用于创建具有指定存储模式的 StoreConfig 的 Builder 实例。

setJournalMode

public StoreConfig.Builder setJournalMode(StoreConfig.JournalMode journalMode)

设置 StoreConfig 对象的日志模式。

参数：

参数名称	参数描述
journalMode	指示要设置的日志模式。

返回:

返回用于创建具有指定日志模式的 StoreConfig 的 Builder 实例。

setSyncMode

public StoreConfig.Builder setSyncMode(StoreConfig.SyncMode syncMode)

设置 StoreConfig 对象的同步模式。

参数：

参数名称	参数描述
syncMode	指示要设置的同步模式，如 SyncMode 中所列举的。

返回:

返回用于创建具有指定同步模式的 StoreConfig 的 Builder 实例。

setEncryptKey

public StoreConfig.Builder setEncryptKey(byte[] encryptKey)

设置 StoreConfig 对象的加密密钥。

参数：

参数名称	参数描述
encryptKey	指示要设置的加密密钥。

返回:

返回用于使用指定加密密钥创建 StoreConfig 的 Builder 实例。

setReadOnly

public StoreConfig.Builder setReadOnly(boolean isReadOnly)

设置数据库是否为只读。

参数：

参数名称	参数描述
isReadOnly	指示数据库是否为只读。 true 表示数据库是只读的，false 表示不是。

返回:

返回用于创建具有指定权限的 StoreConfig 的 Builder 实例。

setDatabaseFileType

public StoreConfig.Builder setDatabaseFileType(DatabaseFileType databaseFileType)

设置 StoreConfig 对象的数据库文件类型。

参数：

参数名称	参数描述
databaseFileType	指示要设置的数据库文件类型，如 DatabaseFileType 中所枚举。

返回:

返回此 Builder 实例。

setDatabaseFileSecurityLevel

public StoreConfig.Builder setDatabaseFileSecurityLevel(DatabaseFileSecurityLevel databaseFileSecurityLevel)

为数据库文件设置指定的安全级别。

参数：

参数名称	参数描述
databaseFileSecurityLevel	指示要设置的安全级别。

返回:

返回用于创建具有指定安全级别的 StoreConfig 对象的 Builder 实例。

build

public StoreConfig build()

使用具有指定配置的构建器创建 StoreConfig 实例。

返回:

返回创建的 StoreConfig 实例。