程序包 ohos.data.distributed.common

类 Options

java.lang.Object

ohos.data.distributed.common.Options

public class Options
extends Object

Provides configuration options for creating a KvStore.

You can determine whether to create another database if a KvStore database is missing, whether to encrypt the database, and the database type.

从以下版本开始:

1

SystemCapability

SystemCapability.Data#DATA_DISTRIBUTEDDATAMGR

构造器概要

构造器

构造器	说明
Options()

方法概要

限定符和类型	方法	说明
KvStoreType	getKvStoreType()	Obtains the KvStore database type.
Schema	getSchema()	Obtains the Schema from this Options object.
SecurityLevel	getSecurityLevel()	Obtains the KvStore database security level.
boolean	isAutoSync()	Checks whether this KvStore is automatically synchronized with the KvStore of other devices.
boolean	isBackup()	Checks whether this KvStore can be backed up.
boolean	isCreateIfMissing()	Checks whether a KvStore database can be created if no KvStore database is available.
boolean	isEncrypt()	Checks whether the KvStore database is encrypted.
Options	setAutoSync(boolean isAutoSync)	Sets whether to automatically synchronize this KvStore with the KvStore of other devices.
Options	setBackup(boolean isBackup)	Sets whether to enable backup of this KvStore.
Options	setCreateIfMissing(boolean isCreateIfMissing)	Sets whether to create a KvStore database if no KvStore database is available.
Options	setEncrypt(boolean isEncrypt)	Sets whether to encrypt the KvStore database.
Options	setKvStoreType(KvStoreType kvStoreType)	Sets the type of the KvStore database.
Options	setSchema(Schema schema)	Sets the Schema for this Options object.
Options	setSecurityLevel(SecurityLevel securityLevel)	Sets the type of the KvStore database.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Options

public Options()

方法详细资料

isCreateIfMissing

public boolean isCreateIfMissing()

Checks whether a KvStore database can be created if no KvStore database is available.

返回:

Returns true if a KvStore database can be created if no KvStore database is available; returns false otherwise.

从以下版本开始:

1

setCreateIfMissing

public Options setCreateIfMissing(boolean isCreateIfMissing)

Sets whether to create a KvStore database if no KvStore database is available.

参数:

isCreateIfMissing - Specifies whether to create a KvStore database if no KvStore database is available. The value true means to create a KvStore database if no KvStore database is available, and false means the opposite.

返回:

Returns the Options object.

从以下版本开始:

1

isEncrypt

public boolean isEncrypt()

Checks whether the KvStore database is encrypted.

返回:

Returns true if the database is encrypted; returns false otherwise.

从以下版本开始:

1

setEncrypt

public Options setEncrypt(boolean isEncrypt)

Sets whether to encrypt the KvStore database.

参数:

isEncrypt - Specifies whether to encrypt the KvStore database. The value true means to encrypt the KvStore database, and false means not to encrypt the KvStore database.

返回:

Returns the Options object.

从以下版本开始:

1

isBackup

public boolean isBackup()

Checks whether this KvStore can be backed up.

返回:

Returns true if this KvStore can be backed up; returns false otherwise.

从以下版本开始:

1

setBackup

public Options setBackup(boolean isBackup)

Sets whether to enable backup of this KvStore.

参数:

isBackup - Specifies whether to enable backup of this KvStore. The value true means to enable backup of this KvStore, and false means to disable backup of this KvStore.

返回:

Returns the Options object.

从以下版本开始:

1

isAutoSync

public boolean isAutoSync()

Checks whether this KvStore is automatically synchronized with the KvStore of other devices.

This method applies only to DeviceKvStore and SingleKvStore.

返回:

Returns true if this KvStore is automatically synchronized with the KvStore of other devices; returns false otherwise.

从以下版本开始:

1

setAutoSync

public Options setAutoSync(boolean isAutoSync)

Sets whether to automatically synchronize this KvStore with the KvStore of other devices.

This method applies only to DeviceKvStore and SingleKvStore.

参数:

isAutoSync - Specifies whether to automatically synchronize this KvStore with the KvStore of other devices. The value true means to automatically synchronize this KvStore with the KvStore of other devices, and false means the opposite.

返回:

Returns the Options object.

从以下版本开始:

1

getKvStoreType

public KvStoreType getKvStoreType()

Obtains the KvStore database type.

返回:

Returns 0 for SingleKvStore, 1 for MultiKvStore, and 2 for DeviceKvStore, as enumerated in KvStoreType.

从以下版本开始:

1

setKvStoreType

public Options setKvStoreType(KvStoreType kvStoreType)

Sets the type of the KvStore database.

参数:

kvStoreType - Indicates the KvStore type, as enumerated in KvStoreType.

返回:

Returns an Options object.

从以下版本开始:

1

getSchema

public Schema getSchema()

Obtains the Schema from this Options object.

返回:

Returns the Schema.

从以下版本开始:

3

setSchema

public Options setSchema(Schema schema)

Sets the Schema for this Options object.

After the Schema is set, the database will be created or opened as a schema database.

参数:

schema - Indicates the Schema to set.

返回:

Returns this Options object with the Schema set.

从以下版本开始:

3

getSecurityLevel

public SecurityLevel getSecurityLevel()

Obtains the KvStore database security level.

返回:

Returns the KvStore database security level. as enumerated in SecurityLevel.

从以下版本开始:

5

setSecurityLevel

public Options setSecurityLevel(SecurityLevel securityLevel)

Sets the type of the KvStore database.

参数:

securityLevel - Indicates the KvStore security level, as enumerated in SecurityLevel.

返回:

Returns an Options object.

从以下版本开始:

5