鸿蒙OS Parcel

Parcel

java.lang.Object

|—ohos.utils.Parcel

public class Parcel
extends Object

用于进程间通信 (IPC) 的数据对象。

在 IPC 过程中，发送方可以使用 Parcel 提供的 write 方法将要发送的数据以特定格式写入 Parcel 对象，接收方可以使用 Parcel 提供的 read 方法从 包裹对象。

Parcel 实例的默认容量为 200KB。 如果您想要更多或更少，请使用 setCapacity(int) 更改它。

注意：只有以下数据类型的数据可以写入或读取 Parcel：byte、byteArray、short、shortArray、int、intArray、long、longArray、float、floatArray、double、doubleArray、boolean、booleanArray、char、charArray 、字符串、StringArray、PlainBooleanArray、Serializable、Sequenceable 和 SequenceableArray。

构造函数摘要

方法总结

构造函数详细信息

Parcel

protected Parcel()

方法详情

flushBuffer

protected void flushBuffer()

清除 Parcel 实例中的数据。

finalize

protected void finalize() throws Throwable

从类复制的描述：对象

当垃圾收集确定不再有对该对象的引用时，由对象上的垃圾收集器调用。子类覆盖 finalize 方法以释放系统资源或执行其他清理。

finalize 的一般约定是，当 Java™ 虚拟机确定不再有任何方法可以让任何尚未终止的线程访问该对象时调用它，除非是由于某个操作而导致的。由准备完成的其他对象或类的完成所采取。 finalize 方法可以采取任何行动，包括使该对象再次可供其他线程使用；然而，finalize 的通常目的是在对象被不可撤销地丢弃之前执行清理操作。例如，代表输入/输出连接的对象的 finalize 方法可能会执行显式 I/O 事务以在对象被永久丢弃之前中断连接。

Object 类的 finalize 方法不执行任何特殊操作；它只是正常返回。 Object 的子类可以覆盖这个定义。

Java 编程语言不保证哪个线程将为任何给定对象调用 finalize 方法。但是，可以保证调用 finalize 的线程在调用 finalize 时不会持有任何用户可见的同步锁。如果 finalize 方法抛出未捕获的异常，则忽略该异常并终止该对象的终结。

在为一个对象调用 finalize 方法后，不会采取进一步的行动，直到 Java 虚拟机再次确定没有任何方法可以让任何尚未终止的线程访问该对象，包括可能的行动由其他准备完成的对象或类，此时该对象可能被丢弃。

对于任何给定的对象，Java 虚拟机永远不会多次调用 finalize 方法。

finalize 方法抛出的任何异常都会导致该对象的终结被暂停，否则会被忽略。

覆盖：

在类 Object 中完成

Throws:

create

public static Parcel create()

创建一个空的 Parcel 实例。

返回:

返回一个 Parcel 实例。

create

public static Parcel create(long nativeHandler)

使用指定的处理程序创建一个空 Parcel 实例。

参数：

返回:

返回具有指定处理程序的 Parcel 实例。

reclaim

public void reclaim()

清除 Parcel 实例中的数据。

getSize

public final int getSize()

获取 Parcel 实例中包含的数据大小（以字节为单位）。

返回:

返回 Parcel 实例中包含的数据的大小。

getCapacity

public final int getCapacity()

获取 Parcel 实例的存储容量（以字节为单位）。

返回:

返回 Parcel 实例的存储容量。

setSize

public final boolean setSize(int size)

设置 Parcel 实例中包含的数据大小（以字节为单位）。

如果此方法中设置的数据大小大于 Parcel 的存储容量，则返回 false。

参数：

返回:

设置成功返回 true； 否则返回 false。

setCapacity

public final boolean setCapacity(int capacity)

设置 Parcel 实例的存储容量（以字节为单位）。

如果此方法中设置的容量小于 Parcel 中包含的数据大小，则返回 false。

参数：

返回:

设置成功返回true； 否则返回 false。

getWritableBytes

public final int getWritableBytes()

获取 Parcel 实例中的可写数据空间（以字节为单位）。

可写数据空间 = Parcel 的存储容量 – Parcel 中包含的数据大小。

返回:

返回 Parcel 实例的可写数据空间。

getReadableBytes

public final int getReadableBytes()

获取 Parcel 实例中的可读数据空间（以字节为单位）。

可读数据空间 = Parcel 中包含的数据大小 – 已读取数据的大小。

返回:

返回 Parcel 实例的可读数据空间。

getReadPosition

public final int getReadPosition()

获取 Parcel 实例中的当前读取位置。

返回:

返回 Parcel 实例中的当前读取位置。

getWritePosition

public final int getWritePosition()

获取 Parcel 实例中的当前写入位置。

返回:

返回 Parcel 实例中的当前写入位置。

rewindRead

public final boolean rewindRead(int pos)

更改 Parcel 实例中的当前读取位置。

一般不建议更改当前读取位置。 如果必须更改，请将其更改到准确的位置。 否则，读取的数据可能不正确。

参数：

返回:

如果读取位置改变，则返回 true； 否则返回 false。

rewindWrite

public final boolean rewindWrite(int pos)

更改 Parcel 实例中的当前写入位置。

一般不建议更改当前写入位置。 如果必须更改，请将其更改到准确的位置。 否则，要读取的数据可能不正确。

参数：

返回:

如果写入位置改变，则返回 true； 否则返回 false。

writeByte

public final boolean writeByte(byte val)

将字节值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeShort

public final boolean writeShort(short val)

将一个短整数值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeInt

public final boolean writeInt(int val)

将整数值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeLong

public final boolean writeLong(long val)

将一个长整数值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeFloat

public final boolean writeFloat(float val)

将浮点值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeDouble

public final boolean writeDouble(double val)

将双精度浮点值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeBoolean

public final boolean writeBoolean(boolean val)

将一个布尔值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeChar

public final boolean writeChar(char val)

将单个字符值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeString

public final boolean writeString(String val)

将字符串值写入 Parcel 实例。

参数：

返回:

如果值已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeSequenceable

public final void writeSequenceable(Sequenceable val)

将 Sequenceable 对象写入 Parcel 实例。

参数：

Throws:

readByte

public final byte readByte()

从 Parcel 实例中读取一个字节值。

返回:

返回一个字节值。

readShort

public final short readShort()

从 Parcel 实例中读取一个短整数值。

返回:

返回一个短整数值。

readInt

public final int readInt()

从 Parcel 实例中读取一个整数值。

返回:

返回一个整数值。

readLong

public final long readLong()

从 Parcel 实例中读取一个长整数值。

返回:

返回一个长整数值。

readFloat

public final float readFloat()

从 Parcel 实例中读取一个浮点值。

返回:

返回一个浮点值。

readDouble

public final double readDouble()

从 Parcel 实例中读取一个双精度浮点值。

返回:

返回一个双精度浮点值。

readBoolean

public final boolean readBoolean()

从 Parcel 实例中读取一个布尔值。

返回:

返回一个布尔值。

readChar

public final char readChar()

从 Parcel 实例中读取单个字符值。

返回:

返回单个字符值。

readString

public final String readString()

从 Parcel 实例中读取字符串值。

返回:

返回一个字符串值。

readSequenceable

public final boolean readSequenceable(Sequenceable in)

从 Parcel 实例中读取一个 Sequenceable 对象。

参数：

返回:

如果解组成功，则返回 true； 否则返回 false。

writeByteArray

public final boolean writeByteArray(byte[] val)

将字节数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeBytes

public final boolean writeBytes(byte[] val)

将字节写入 Parcel 实例。

此方法与 writeByteArray 方法不同。 在该方法中，Parcel 不能调用其他方法写入数据，写入的数据只能通过调用 getBytes() 来读取。

参数：

返回:

如果字节已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeShortArray

public final boolean writeShortArray(short[] values)

将一个短整数数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeIntArray

public final boolean writeIntArray(int[] values)

将整数数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeLongArray

public final boolean writeLongArray(long[] values)

将一个长整数数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeFloatArray

public final boolean writeFloatArray(float[] values)

将浮点数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeDoubleArray

public final boolean writeDoubleArray(double[] values)

将双精度浮点数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeBooleanArray

public final boolean writeBooleanArray(boolean[] values)

将一个布尔数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeCharArray

public final boolean writeCharArray(char[] values)

将单个字符数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeStringArray

public final boolean writeStringArray(String[] values)

将字符串数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeStringList

public final boolean writeStringList(ListString values)

将字符串列表写入此 Parcel 实例。

参数：

返回:

如果字符串列表写入成功，则返回 true； 否则返回 false。

Throws:

writeSequenceableArray

public final boolean writeSequenceableArray(Sequenceable[] values)

将 Sequenceable 对象数组写入 Parcel 实例。

参数：

返回:

如果数组已写入 Parcel，则返回 true； 否则返回 false。

Throws:

writeSequenceableList

public final boolean writeSequenceableList(List<? extends Sequenceable> values)

将 Sequenceable 列表写入此 Parcel 实例。

此列表中的元素类型必须是实现了 Sequenceable 的东西。 调用readSequenceableList(java.lang.Class)方法读取列表时，确保values的元素是同一类型。

参数：

返回:

如果 Sequenceable 列表写入成功，则返回 true； 否则返回 false。

Throws:

writeSequenceableMap

public final boolean writeSequenceableMap(Map<String,? extends Sequenceable> values)

将 Map 对象写入此 Parcel 实例。

在 Map 对象中，键是 String 类型，值来自实现了 Sequenceable 的东西。 调用readSequenceableMap(java.lang.Class)方法读取map时，需要保证values的元素类型相同。

参数：

返回:

如果 Map 对象写入成功，则返回 true； 否则返回 false。

Throws:

readByteArray

public final void readByteArray(byte[] val)

从 Parcel 实例中读取一个字节数组。

参数：

Throws:

readByteArray

public final byte[] readByteArray()

从 Parcel 实例中读取一个字节数组。

返回:

返回一个字节数组。

getBytes

public final byte[] getBytes()

从 Parcel 实例中读取所有字节。

此方法与 readByteArray 方法不同。 在该方法中，Parcel 不能调用其他方法读取数据，该方法只能读取使用 [writeBytes(byte]) 写入的数据。

返回:

返回字节。

readShortArray

public final void readShortArray(short[] val)

从 Parcel 实例中读取一个短整数数组。

参数：

Throws:

readShortArray

public final short[] readShortArray()

从 Parcel 实例中读取一个短整数数组。

返回:

返回一个短整数数组。

readIntArray

public final void readIntArray(int[] val)

从 Parcel 实例中读取一个整数数组。

参数：

Throws:

readIntArray

public final int[] readIntArray()

从 Parcel 实例中读取一个整数数组。

返回:

返回一个整数数组。

readLongArray

public final void readLongArray(long[] val)

从 Parcel 实例中读取一个长整数数组。

参数：

Throws:

readLongArray

public final long[] readLongArray()

从 Parcel 实例中读取一个长整数数组。

返回:

返回一个长整数数组。

readFloatArray

public final void readFloatArray(float[] val)

从 Parcel 实例中读取一个浮点数组。

参数：

Throws:

readFloatArray

public final float[] readFloatArray()

从 Parcel 实例中读取一个浮点数组。

返回:

返回一个浮点数组。

readDoubleArray

public final void readDoubleArray(double[] val)

从 Parcel 实例中读取一个双精度浮点数组。

参数：

Throws:

readDoubleArray

public final double[] readDoubleArray()

从 Parcel 实例中读取一个双精度浮点数组。

返回:

返回一个双精度浮点数组。

readBooleanArray

public final void readBooleanArray(boolean[] val)

从 Parcel 实例中读取一个布尔数组。

参数：

Throws:

readBooleanArray

public final boolean[] readBooleanArray()

从 Parcel 实例中读取一个布尔数组。

返回:

返回一个布尔数组。

readCharArray

public final void readCharArray(char[] val)

从 Parcel 实例中读取单个字符数组。

参数：

Throws:

readCharArray

public final char[] readCharArray()

从 Parcel 实例中读取单个字符数组。

返回:

返回单个字符数组。

readStringArray

public final void readStringArray(String[] val)

从 Parcel 实例中读取一个字符串数组。

参数：

Throws:

readStringArray

public final String[] readStringArray()

从 Parcel 实例中读取一个字符串数组。

返回:

返回一个字符串数组。

readStringList

public final ListString readStringList()

从 Parcel 读取字符串列表。

您可以使用此方法读取 writeStringList(java.util.List) 和 [writeStringArray(java.lang.String]) 写入 Parcel 的字符串。

返回:

返回一个只读字符串列表对象。

readSequenceableArray

public final void readSequenceableArray(Sequenceable[] val)

从 Parcel 实例中读取一个 Sequenceable 对象数组。

参数：

Throws:

readSequenceableList

public final <T extends Sequenceable> List<T> readSequenceableList(Class<T> clz)

从此 Parcel 实例中读取指定类型的 Sequenceable 对象列表。

提供 Sequenceable 对象的类必须具有 Sequenceable.Producer 类型的静态成员变量 CREATOR。

参数：

返回:

返回 Sequenceable 对象的列表。

Throws:

readSequenceableMap

public final <T extends Sequenceable> MapString,T readSequenceableMap(Class<T> valueType)

从此 Parcel 实例中读取 Map 对象。 在 Map 对象中，键是 String 类型，值来自实现了 Sequenceable 的东西。

参数：

返回:

返回一个 Map 对象，其键是 String 类型，值来自实现 Sequenceable 的东西。

writeTypedSequenceable

public final void writeTypedSequenceable(Sequenceable sequenceable)

使用 Sequenceable.Producer#createFromParcel(Parcel) 将 Sequenceable 对象写入 Parcel 实例。

此方法还将 Sequenceable 对象的类名写入 Parcel。 类名将用于从 Parcel 中恢复 Sequenceable 对象。

参数：

Throws:

createSequenceable

public final <T extends Sequenceable> T createSequenceable()

使用 Sequenceable.Producer#createFromParcel(Parcel) 从 Parcel 创建特定的 Sequenceable 对象。

该方法根据writeTypedSequenceable(ohos.utils.Sequenceable)写入的类名恢复Sequenceable对象。

返回:

返回新创建的 Sequenceable 对象； 如果无法恢复 Sequenceable 对象，则返回 null。

Throws:

createSequenceable

public final <T extends Sequenceable> T createSequenceable(ClassLoader classLoader)

使用 Sequenceable.Producer#createFromParcel(Parcel) 从 Parcel 创建特定的 Sequenceable 对象。

该方法根据writeTypedSequenceable(ohos.utils.Sequenceable)写入的类名恢复Sequenceable对象。

类型参数：

参数:

返回:

返回新创建的 Sequenceable 对象； 如果无法恢复 Sequenceable 对象，则返回 null。

writeTypedSequenceableArray

public final <T extends Sequenceable> void writeTypedSequenceableArray(T[] values)

使用 Sequenceable.Producer#createFromParcel(Parcel) 将 Sequenceable 对象数组写入 Parcel 实例。

参数：

Throws:

writeSerializable

public final void writeSerializable(Serializable object)

将可序列化对象写入此 Parcel 实例。

参数：

Throws:

readSerializable

public final <T extends Serializable> T readSerializable(Class<T> clz)

从此 Parcel 实例中读取一个可序列化的对象。

参数：

返回:

返回已读取的可序列化对象； 如果无法读取可序列化对象，则返回 null。

Throws:

createSequenceableArray

public final Sequenceable[] createSequenceableArray()

使用 Sequenceable.Producer#createFromParcel(Parcel) 从 Parcel 创建一个特定的 Sequenceable 对象数组

返回:

返回新创建的 Sequenceable 对象数组； 如果无法恢复 Sequenceable 对象数组，则返回 null。

Throws:

readList

public List<?> readList()

从此 Parcel 实例中读取对象列表。

返回:

返回对象列表。

Throws:

writeList

public void writeList(List<?> values)

将对象列表写入此 Parcel 实例。

参数：

Throws:

readMap

public Map<?,?> readMap()

从此 Parcel 实例中读取 Map 对象。

返回:

返回一个 map 对象。

Throws:

writeMap

public void writeMap(Map<?,?> values)

将 Map 对象写入此 Parcel 实例。

Map 对象中的键值对类型必须是 Parcel 支持的。 否则会抛出异常。

参数：

Throws:

writeMap

public final void writeMap(Map<?,?> values, boolean isCross)

通过支持跨平台将 Map 对象写入此 Parcel 实例。

Map 对象中的键值对类型必须是 Parcel 支持的。 否则会抛出异常。

参数：

Throws:

writeValue

public final void writeValue(Object value)

将对象写入此 Parcel 实例。

这是一种无需声明类型即可编写对象的通用方法。 请注意以下事项：

• 要写入的对象类型必须由 Parcel 支持。
• 您只能使用 readValue() 来读取已写入的对象。

参数：

Throws:

readValue

public final Object readValue()

从此 Parcel 实例中读取一个对象。

该方法只能读取 writeValue(java.lang.Object) 写入的对象。

返回:

返回对象。

Throws:

appendFrom

public final boolean appendFrom(Parcel other)

将指定 Parcel 对象的序列化值附加到此 Parcel 实例。

参数：

返回:

如果运算符成功，则返回 true，否则返回 false。

Throws:

writePlainBooleanArray

public final boolean writePlainBooleanArray(PlainBooleanArray value)

将 PlainBooleanArray 对象写入此 Parcel 实例。

参数：

返回:

如果 PlainBooleanArray 对象写入成功，则返回 true； 否则返回 false。

Throws:

readPlainBooleanArray

public final PlainBooleanArray readPlainBooleanArray()

从此 Parcel 实例中读取一个 PlainBooleanArray 对象。

返回:

返回 PlainBooleanArray 对象。

writePlainArray

public final <T> void writePlainArray(PlainArray<T> value)

将 PlainArray 对象写入此 Parcel 实例。

类型参数：

参数:

Throws:

readPlainArray

public final <T> PlainArray<T> readPlainArray(Class<T> clzType)

从此 Parcel 实例中读取一个 PlainArray 对象。

类型参数：

返回:

返回 PlainArray 对象。

Throws:

writeParcelableEx

public final void writeParcelableEx(ParcelableEx val)

将 ParcelableEx 对象写入此 Parcel 实例。

参数：

Throws:

writePacMapEx

public final void writePacMapEx(PacMapEx val)

将 PacMapEx 对象写入此 Parcel 实例。

参数：

Throws:

readPacMapEx

public final void readPacMapEx(PacMapEx pacMapEx)

从此 Parcel 对象中读取 PacMapEx 对象。

参数：

Throws:

readParcelableEx

public final ParcelableEx readParcelableEx(ClassLoader loader)

从此 Parcel 实例中读取 ParcelableEx 对象。

如果 Parcel 实例不包含类名或类名不能用于调用无参构造函数创建 ParcelableEx 对象，则读取操作失败。

参数：

返回:

如果操作成功，则返回未编组的 ParcelableEx 对象； 否则返回 null。

Throws:

addAppClassLoader

public void addAppClassLoader(ClassLoader newClassLoader)

添加第三方 ClassLoader 用于实例初始化。

如果您需要编组或解组自定义 Sequenceable 实例，请添加您自己的 ClassLoader。

参数：