BackupDataOutput

public class BackupDataOutput
extends Object

提供结构化接口， BackupAgent通过其onBackup()方法将信息提交到备份数据集。 为备份写入的数据表示为一组“实体”键/值对，其中每个二进制数据记录“值”用字符串“键”命名。

要向备份传输提交数据记录，代理的方法onBackup()首先会写入一个“实体标题”，用于提供记录的密钥字符串以及该记录的二进制值的总大小。 标题写完后，代理会自己写入二进制实体值。 如果需要，可以将实体值写入多个块中，只要写入的字节总数与提供给writeEntityHeader()的字节数相匹配writeEntityHeader() 。

实体密钥字符串在给定应用程序的备份数据集中被认为是唯一的。 如果备份代理在现有的密钥字符串下写入新的实体，则其值将替换传输的远程数据存储中的任何先前值。 您可以使用现有记录的密钥写入新的实体标题，但是提供一个负数参数dataSize ，从而完全从远程数据集中删除记录。 当您这样做时，代理不需要致电writeEntityData(byte[], int) 。

Example

以下是一个示例，说明如何备份名为 mStringToBackUp的String变量的值：

 static final String MY_STRING_KEY = "storedstring";

 public void onBackup(ParcelFileDescriptor oldState, BackupDataOutput data, ParcelFileDescriptor newState)
         throws IOException {
     ...
     byte[] stringBytes = mStringToBackUp.getBytes();
     data.writeEntityHeader(MY_STRING_KEY, stringBytes.length);
     data.writeEntityData(stringBytes, stringBytes.length);
     ...
 }

摘要(Summary)

继承方法(Inherited methods)

From class java.lang.Object Object clone() 创建并返回此对象的副本。 boolean equals(Object obj) 指示其他某个对象是否“等于”这一个。 void finalize() 当垃圾收集确定没有更多对该对象的引用时，由对象上的垃圾回收器调用。 final Class<?> getClass() 返回此 Object的运行时类。 int hashCode() 返回对象的哈希码值。 final void notify() 唤醒正在等待该对象监视器的单个线程。 final void notifyAll() 唤醒在该对象监视器上等待的所有线程。 String toString() 返回对象的字符串表示形式。 final void wait(long millis, int nanos) 导致当前线程等待，直到另一个线程为该对象调用方法 notify()或 notifyAll()方法，或者其他某个线程中断当前线程，或者经过一定的实时时间。 final void wait(long millis) 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法或经过指定的时间量。 final void wait() 使当前线程等待，直到另一个线程调用此对象的方法 notify()或方法 notifyAll() 。

公共方法(Public methods)

int writeEntityData (byte[] data, 
                int size)

int writeEntityHeader (String key, 
                int dataSize)