[API] Rename ParcelVirtualMachine to VirtualMachineDescriptor
Test: atest MicrodroidTests
Bug: 243129654
Change-Id: I4ab0a2a2bf1b173f167b81a231aceff8246c6dc9
diff --git a/javalib/src/android/system/virtualmachine/VirtualMachine.java b/javalib/src/android/system/virtualmachine/VirtualMachine.java
index 7c826b6..cf791e4 100644
--- a/javalib/src/android/system/virtualmachine/VirtualMachine.java
+++ b/javalib/src/android/system/virtualmachine/VirtualMachine.java
@@ -895,22 +895,22 @@
}
/**
- * Captures the current state of the VM in a {@link ParcelVirtualMachine} instance.
- * The VM needs to be stopped to avoid inconsistency in its state representation.
+ * Captures the current state of the VM in a {@link VirtualMachineDescriptor} instance. The VM
+ * needs to be stopped to avoid inconsistency in its state representation.
*
- * @return a {@link ParcelVirtualMachine} instance that represents the VM's state.
+ * @return a {@link VirtualMachineDescriptor} instance that represents the VM's state.
* @throws VirtualMachineException if the virtual machine is not stopped, or the state could not
* be captured.
*/
@NonNull
- public ParcelVirtualMachine toParcelVirtualMachine() throws VirtualMachineException {
+ public VirtualMachineDescriptor toDescriptor() throws VirtualMachineException {
synchronized (mLock) {
checkStopped();
}
try {
- return new ParcelVirtualMachine(
- ParcelFileDescriptor.open(mConfigFilePath, MODE_READ_ONLY),
- ParcelFileDescriptor.open(mInstanceFilePath, MODE_READ_ONLY));
+ return new VirtualMachineDescriptor(
+ ParcelFileDescriptor.open(mConfigFilePath, MODE_READ_ONLY),
+ ParcelFileDescriptor.open(mInstanceFilePath, MODE_READ_ONLY));
} catch (IOException e) {
throw new VirtualMachineException(e);
}
diff --git a/javalib/src/android/system/virtualmachine/ParcelVirtualMachine.java b/javalib/src/android/system/virtualmachine/VirtualMachineDescriptor.java
similarity index 74%
rename from javalib/src/android/system/virtualmachine/ParcelVirtualMachine.java
rename to javalib/src/android/system/virtualmachine/VirtualMachineDescriptor.java
index 808f30a..70532fc 100644
--- a/javalib/src/android/system/virtualmachine/ParcelVirtualMachine.java
+++ b/javalib/src/android/system/virtualmachine/VirtualMachineDescriptor.java
@@ -26,15 +26,15 @@
import com.android.internal.annotations.VisibleForTesting;
/**
- * A parcelable that captures the state of a Virtual Machine.
+ * A VM descriptor that captures the state of a Virtual Machine.
*
* <p>You can capture the current state of VM by creating an instance of this class with {@link
- * VirtualMachine#toParcelVirtualMachine()}, optionally pass it to another App, and then build an
- * identical VM with the parcel received.
+ * VirtualMachine#toDescriptor()}, optionally pass it to another App, and then build an identical VM
+ * with the descriptor received.
*
* @hide
*/
-public final class ParcelVirtualMachine implements Parcelable {
+public final class VirtualMachineDescriptor implements Parcelable {
private final @NonNull ParcelFileDescriptor mConfigFd;
private final @NonNull ParcelFileDescriptor mInstanceImgFd;
// TODO(b/243129654): Add trusted storage fd once it is available.
@@ -50,14 +50,14 @@
mInstanceImgFd.writeToParcel(out, flags);
}
- public static final Parcelable.Creator<ParcelVirtualMachine> CREATOR =
- new Parcelable.Creator<ParcelVirtualMachine>() {
- public ParcelVirtualMachine createFromParcel(Parcel in) {
- return new ParcelVirtualMachine(in);
+ public static final Parcelable.Creator<VirtualMachineDescriptor> CREATOR =
+ new Parcelable.Creator<VirtualMachineDescriptor>() {
+ public VirtualMachineDescriptor createFromParcel(Parcel in) {
+ return new VirtualMachineDescriptor(in);
}
- public ParcelVirtualMachine[] newArray(int size) {
- return new ParcelVirtualMachine[size];
+ public VirtualMachineDescriptor[] newArray(int size) {
+ return new VirtualMachineDescriptor[size];
}
};
@@ -79,13 +79,13 @@
return mInstanceImgFd;
}
- ParcelVirtualMachine(
+ VirtualMachineDescriptor(
@NonNull ParcelFileDescriptor configFd, @NonNull ParcelFileDescriptor instanceImgFd) {
mConfigFd = configFd;
mInstanceImgFd = instanceImgFd;
}
- private ParcelVirtualMachine(Parcel in) {
+ private VirtualMachineDescriptor(Parcel in) {
mConfigFd = requireNonNull(in.readFileDescriptor());
mInstanceImgFd = requireNonNull(in.readFileDescriptor());
}
diff --git a/tests/testapk/src/java/com/android/microdroid/test/MicrodroidTests.java b/tests/testapk/src/java/com/android/microdroid/test/MicrodroidTests.java
index cc623a8..0e9ba55 100644
--- a/tests/testapk/src/java/com/android/microdroid/test/MicrodroidTests.java
+++ b/tests/testapk/src/java/com/android/microdroid/test/MicrodroidTests.java
@@ -30,10 +30,10 @@
import android.os.ParcelFileDescriptor;
import android.os.ServiceSpecificException;
import android.os.SystemProperties;
-import android.system.virtualmachine.ParcelVirtualMachine;
import android.system.virtualmachine.VirtualMachine;
import android.system.virtualmachine.VirtualMachineCallback;
import android.system.virtualmachine.VirtualMachineConfig;
+import android.system.virtualmachine.VirtualMachineDescriptor;
import android.system.virtualmachine.VirtualMachineException;
import android.system.virtualmachine.VirtualMachineManager;
import android.util.Log;
@@ -600,7 +600,7 @@
}
@Test
- public void vmConvertsToValidParcelVm() throws Exception {
+ public void vmConvertsToValidDescriptor() throws Exception {
// Arrange
VirtualMachineConfig config =
mInner.newVmConfigBuilder()
@@ -611,11 +611,11 @@
VirtualMachine vm = mInner.forceCreateNewVirtualMachine(vmName, config);
// Action
- ParcelVirtualMachine parcelVm = vm.toParcelVirtualMachine();
+ VirtualMachineDescriptor descriptor = vm.toDescriptor();
// Asserts
- assertFileContentsAreEqual(parcelVm.getConfigFd(), vmName, "config.xml");
- assertFileContentsAreEqual(parcelVm.getInstanceImgFd(), vmName, "instance.img");
+ assertFileContentsAreEqual(descriptor.getConfigFd(), vmName, "config.xml");
+ assertFileContentsAreEqual(descriptor.getInstanceImgFd(), vmName, "instance.img");
}
private void assertFileContentsAreEqual(
