鸿蒙OS ValuesBucket

ValuesBucket

java.lang.Object

|---ohos.data.rdb.ValuesBucket

public class ValuesBucket
extends Object
implements Sequenceable

管理用于存储一系列值的存储桶。

桶中的值存储在键值对中。

嵌套类摘要

从接口 ohos.utils.Sequenceable 继承的嵌套类/接口
Sequenceable.ProducerT

构造函数摘要

构造函数	描述
ValuesBucket()	用于创建具有默认初始大小的空 ValuesBucket 实例的无参数构造函数。
ValuesBucket(int size)	用于创建具有给定初始大小的空 ValuesBucket 实例的构造函数。
ValuesBucket(ValuesBucket values)	用于通过从现有实例复制值来创建 ValuesBucket 实例的构造函数。
ValuesBucket(Parcel in)	用于通过从 Parcel 对象复制值来创建 ValuesBucket 实例的构造函数。

方法总结

修饰符和类型	方法	描述
void	clear()	清除当前 ValuesBucket 中的所有值。
void	delete(String columnName)	从当前 ValuesBucket 中删除指定列名的值。
boolean	equals(Object object)	指示某个其他对象是否“等于”这个对象。
SetMap.EntryString,Object	getAll()	获取包含存储在当前 ValuesBucket 中的所有列及其值的 Set。
Boolean	getBoolean(String columnName)	获取指定列名的布尔值。
Byte	getByte(String columnName)	获取指定列名的字节值。
byte[]	getByteArray(String columnName)	获取指定列名的字节数组值。
SetString	getColumnSet()	获取包含存储在当前 ValuesBucket 中的所有列的 Set。
Double	getDouble(String columnName)	获取指定列名的 Double 值。
Float	getFloat(String columnName)	获取指定列名的浮点值。
Integer	getInteger(String columnName)	获取指定列名的整数值。
Long	getLong(String columnName)	获取指定列名的 Long 值。
Object	getObject(String columnName)	获取指定列名的 Object 值。
Short	getShort(String columnName)	获取指定列名的 Short 值。
String	getString(String columnName)	获取指定列名的String值。
boolean	hasColumn(String columnName)	检查当前 ValuesBucket 是否包含指定列名的值。
int	hashCode()	返回对象的哈希码值。
boolean	isEmpty()	检查当前 ValuesBucket 是否为空。
boolean	marshalling(Parcel out)	将 ValuesBucket 对象写入 Parcel。
void	putBoolean(String columnName, Boolean value)	将一个布尔值放入当前的 ValuesBucket 并将其与给定的列名相关联。
void	putByte(String columnName, Byte value)	将一个字节值放入当前的 ValuesBucket 并将其与给定的列名相关联。
void	putByteArray(String columnName, byte[] value)	将字节数组值放入当前的 ValuesBucket 并将其与给定的列名相关联。
void	putDouble(String columnName, Double value)	将 Double 值放入当前 ValuesBucket 并将其与给定的列名相关联。
void	putFloat(String columnName, Float value)	将 Float 值放入当前 ValuesBucket 并将其与给定的列名相关联。
void	putInteger(String columnName, Integer value)	将一个整数值放入当前的 ValuesBucket 并将其与给定的列名相关联。
void	putLong(String columnName, Long value)	将 Long 值放入当前 ValuesBucket 并将其与给定的列名相关联。
void	putNull(String columnName)	将一个空值放入当前的 ValuesBucket 并将其与给定的列名相关联。
void	putShort(String columnName, Short value)	将 Short 值放入当前 ValuesBucket 并将其与给定的列名相关联。
void	putString(String columnName, String value)	将 String 值放入当前 ValuesBucket 并将其与给定的列名相关联。
void	putValues(ValuesBucket other)	将指定 ValuesBucket 的值放入当前 ValuesBucket。
int	size()	获取当前 ValuesBucket 中存储的值的数量。
String	toString()	返回对象的字符串表示形式。
boolean	unmarshalling(Parcel in)	从 Parcel 中读取 ValuesBucket 对象。

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

从接口 ohos.utils.Sequenceable 继承的方法
hasFileDescriptor

构造函数详细信息

ValuesBucket

public ValuesBucket()

用于创建具有默认初始大小的空 ValuesBucket 实例的无参数构造函数。

ValuesBucket

public ValuesBucket(int size)

用于创建具有给定初始大小的空 ValuesBucket 实例的构造函数。

参数：

参数名称	参数描述
size	指示 ValuesBucket 实例的初始大小。

ValuesBucket

public ValuesBucket(ValuesBucket values)

用于通过从现有实例复制值来创建 ValuesBucket 实例的构造函数。

参数：

参数名称	参数描述
values	指示现有的 ValuesBucket 对象。

ValuesBucket

public ValuesBucket(Parcel in)

用于通过从 Parcel 对象复制值来创建 ValuesBucket 实例的构造函数。

参数：

参数名称	参数描述
in	指示 Parcel 对象。

方法详情

putString

public void putString(String columnName, String value)

将 String 值放入当前 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	表示 String 值的列名。
value	表示字符串值。

putValues

public void putValues(ValuesBucket other)

将指定 ValuesBucket 的值放入当前 ValuesBucket。

如果当前 ValuesBucket 中已经存在任何指定的列，则它们的值将被指定的 ValuesBucket 中的列的值替换。

参数：

参数名称	参数描述
other	表示指定的ValuesBucket。

putByte

public void putByte(String columnName, Byte value)

将一个字节值放入当前的 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	表示字节值的列名。
value	表示字节值。

putShort

public void putShort(String columnName, Short value)

将 Short 值放入当前 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	表示 Short 值的列名。
value	表示 Short 值。

putInteger

public void putInteger(String columnName, Integer value)

将一个整数值放入当前的 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	指示整数值的列名。
value	表示整数值。

putLong

public void putLong(String columnName, Long value)

将 Long 值放入当前 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	表示 Long 值的列名。
value	表示 Long 值。

putFloat

public void putFloat(String columnName, Float value)

将 Float 值放入当前 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	指示浮点值的列名。
value	指示浮点值。

putDouble

public void putDouble(String columnName, Double value)

将 Double 值放入当前 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	指示 Double 值的列名。
value	表示 Double 值。

putBoolean

public void putBoolean(String columnName, Boolean value)

将一个布尔值放入当前的 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	表示布尔值的列名。
value	表示布尔值。

putByteArray

public void putByteArray(String columnName, byte[] value)

将字节数组值放入当前的 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已经存在于 ValuesBucket 中，它的值将被给定的值替换。

参数：

参数名称	参数描述
columnName	表示字节数组值的列名。
value	表示字节数组值。

putNull

public void putNull(String columnName)

将一个空值放入当前的 ValuesBucket 并将其与给定的列名相关联。

如果给定的列名已存在于 ValuesBucket 中，则其值将被替换为 null。

参数：

参数名称	参数描述
columnName	表示空值的列名。

size

public int size()

获取当前 ValuesBucket 中存储的值的数量。

返回:

返回当前 ValuesBucket 中存储的值的数量。

isEmpty

public boolean isEmpty()

检查当前 ValuesBucket 是否为空。

返回:

如果 ValuesBucket 不包含任何值，则返回 true； 否则返回 false。

delete

public void delete(String columnName)

从当前 ValuesBucket 中删除指定列名的值。

如果 ValuesBucket 不包含给定的列名，则此方法不会执行任何操作。

参数：

参数名称	参数描述
columnName	表示要删除的值的列名。

clear

public void clear()

清除当前 ValuesBucket 中的所有值。

调用此方法后，当前的 ValuesBucket 将为空。

hasColumn

public boolean hasColumn(String columnName)

检查当前 ValuesBucket 是否包含指定列名的值。

参数：

参数名称	参数描述
columnName	表示值的列名。

返回:

如果给定列名的值存在，则返回 true； 否则返回 false。

getObject

public Object getObject(String columnName)

获取指定列名的 Object 值。

参数：

参数名称	参数描述
columnName	表示 Object 值的列名。

返回:

如果有的话，返回给定列名的对象值； 否则返回 null。

getString

public String getString(String columnName)

获取指定列名的String值。

参数：

参数名称	参数描述
columnName	表示 String 值的列名。

返回:

如果有的话，返回给定列名的字符串值； 否则返回 null。

getLong

public Long getLong(String columnName)

获取指定列名的 Long 值。

参数：

参数名称	参数描述
columnName	表示 Long 值的列名。

返回:

如果有的话，返回给定列名的 Long 值； 否则返回 null。

getInteger

public Integer getInteger(String columnName)

获取指定列名的整数值。

参数：

参数名称	参数描述
columnName	指示整数值的列名。

返回:

如果有的话，返回给定列名的整数值； 否则返回 null。

getShort

public Short getShort(String columnName)

获取指定列名的 Short 值。

参数：

参数名称	参数描述
columnName	表示 Short 值的列名。

返回:

如果有的话，返回给定列名的 Short 值； 否则返回 null。

getByte

public Byte getByte(String columnName)

获取指定列名的字节值。

参数：

参数名称	参数描述
columnName	表示字节值的列名。

返回:

如果有的话，返回给定列名的字节值； 否则返回 null。

getDouble

public Double getDouble(String columnName)

获取指定列名的 Double 值。

参数：

参数名称	参数描述
columnName	指示 Double 值的列名。

返回:

如果有的话，返回给定列名的 Double 值； 否则返回 null。

getFloat

public Float getFloat(String columnName)

获取指定列名的浮点值。

参数：

参数名称	参数描述
columnName	指示浮点值的列名。

返回:

如果有的话，返回给定列名的浮点值； 否则返回 null。

getBoolean

public Boolean getBoolean(String columnName)

获取指定列名的布尔值。

参数：

参数名称	参数描述
columnName	表示布尔值的列名。

返回:

如果有的话，返回给定列名的布尔值； 否则返回 null。

getByteArray

public byte[] getByteArray(String columnName)

获取指定列名的字节数组值。

参数：

参数名称	参数描述
columnName	表示字节数组值的列名。

返回:

如果有的话，返回给定列名的字节数组值； 否则返回 null。

getAll

public SetMap.EntryString,Object getAll()

获取包含存储在当前 ValuesBucket 中的所有列及其值的 Set。

返回:

返回一个 Set，其中包含存储在当前 ValuesBucket 中的所有列及其值。

getColumnSet

public SetString getColumnSet()

获取包含存储在当前 ValuesBucket 中的所有列的 Set。

返回:

返回包含存储在当前 ValuesBucket 中的所有列的 Set。

equals

public boolean equals(Object object)

从类复制的描述：对象

指示某个其他对象是否“等于”这个对象。

equals 方法在非空对象引用上实现等价关系：

• 它是自反的：对于任何非空引用值 x，x.equals(x) 应该返回 true。
• 它是对称的：对于任何非空引用值 x 和 y，当且仅当 y.equals(x) 返回 true 时，x.equals(y) 才应该返回 true。
• 它是可传递的：对于任何非空引用值 x、y 和 z，如果 x.equals(y) 返回 true 并且 y.equals(z) 返回 true，则 x.equals(z) 应该返回 true。
• 它是一致的：对于任何非空引用值 x 和 y，x.equals(y) 的多次调用始终返回 true 或始终返回 false，前提是没有修改对象上 equals 比较中使用的信息。
• 对于任何非空引用值 x，x.equals(null) 应该返回 false。

Object 类的 equals 方法实现了对象上最有区别的可能等价关系； 也就是说，对于任何非空引用值 x 和 y，当且仅当 x 和 y 引用同一个对象（x == y 的值为 true）时，此方法才返回 true。

请注意，每当重写该方法时，通常都需要重写 hashCode 方法，以维护 hashCode 方法的一般约定，即相等的对象必须具有相等的哈希码。

覆盖：

类 Object 中的等于

参数：

参数名称	参数描述
object	要与之比较的参考对象。

返回:

如果此对象与 obj 参数相同，则为 true； 否则为 false。

hashCode

public int hashCode()

从类复制的描述：对象

返回对象的哈希码值。 支持这种方法是为了有利于哈希表，例如 HashMap 提供的那些。

hashCode 的一般合约是：

• 每当在 Java 应用程序执行期间对同一对象多次调用时，hashCode 方法必须始终返回相同的整数，前提是没有修改对象上相等比较中使用的信息。 该整数不需要从应用程序的一次执行到同一应用程序的另一次执行保持一致。
• 如果两个对象根据 equals(Object) 方法相等，则对两个对象中的每一个调用 hashCode 方法必须产生相同的整数结果。
• 如果根据 Object.equals(java.lang.Object) 方法，如果两个对象不相等，则不要求对两个对象中的每一个调用 hashCode 方法必须产生不同的整数结果。 但是，程序员应该意识到，为不相等的对象生成不同的整数结果可能会提高哈希表的性能。

在合理可行的情况下，由 Object 类定义的 hashCode 方法确实为不同的对象返回不同的整数。 （这通常通过将对象的内部地址转换为整数来实现，但 Java™ 编程语言不需要这种实现技术。）

覆盖：

类 Object 中的 hashCode

返回:

此对象的哈希码值。

toString

public String toString()

从类复制的描述：对象

返回对象的字符串表示形式。 通常，toString 方法返回一个“以文本方式表示”该对象的字符串。 结果应该是一个简洁但信息丰富的表示，易于人们阅读。 建议所有子类重写此方法。

Object 类的 toString 方法返回一个字符串，该字符串由对象作为其实例的类的名称、at 符号字符“@”和对象哈希码的无符号十六进制表示形式组成。 换句话说，此方法返回一个等于以下值的字符串：

 getClass().getName() + '@' + Integer.toHexString(hashCode()) 

覆盖：

类 Object 中的 toString

返回:

对象的字符串表示形式。

marshalling

public boolean marshalling(Parcel out)

将 ValuesBucket 对象写入 Parcel。

指定者：

接口 Sequenceable 中的编组

参数：

参数名称	参数描述
out	表示目标 Parcel。

返回:

如果操作成功，则返回 true； 否则返回 false。

unmarshalling

public boolean unmarshalling(Parcel in)

从 Parcel 中读取 ValuesBucket 对象。

指定者：

在接口 Sequenceable 中解组

参数：

参数名称	参数描述
in	表示目标 Parcel。

返回:

如果操作成功，则返回 true； 否则返回 false。