Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  
  /*
   *  Copyright (C) 2010-2011 Oracle Corporation
   *
   *  This file is part of the VirtualBox SDK, as available from
   *  http://www.virtualbox.org.  This library is free software; you can
   *  redistribute it and/or modify it under the terms of the GNU Lesser General
   *  Public License as published by the Free Software Foundation, in version 2.1
   *  as it comes in the "COPYING.LIB" file of the VirtualBox SDK distribution.
  *  This library is distributed in the hope that it will be useful, but WITHOUT
  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  *  License for more details.
  *
  * ISnapshot.java
  *
  * DO NOT EDIT! This is a generated file.
  * Generated from: src/VBox/Main/idl/VirtualBox.xidl (VirtualBox's interface definitions in XML)
  * Generator: src/VBox/Main/glue/glue-java.xsl
  */
 
 package org.virtualbox_4_2;
 
 import javax.xml.ws.*;
 import java.util.List;

The ISnapshot interface represents a snapshot of the virtual machine. Together with the differencing media that are created when a snapshot is taken, a machine can be brought back to the exact state it was in when the snapshot was taken. The ISnapshot interface has no methods, only attributes; snapshots are controlled through methods of the IConsole interface which also manage the media associated with the snapshot. The following operations exist:
  • IConsole.takeSnapshot(java.lang.String,java.lang.String) creates a new snapshot by creating new, empty differencing images for the machine's media and saving the VM settings and (if the VM is running) the current VM state in the snapshot. The differencing images will then receive all data written to the machine's media, while their parent (base) images remain unmodified after the snapshot has been taken (see IMedium for details about differencing images). This simplifies restoring a machine to the state of a snapshot: only the differencing images need to be deleted. The current machine state is not changed by taking a snapshot except that IMachine.getCurrentSnapshot() is set to the newly created snapshot, which is also added to the machine's snapshots tree.
  • IConsole.restoreSnapshot(org.virtualbox_4_2.ISnapshot) resets a machine to the state of a previous snapshot by deleting the differencing image of each of the machine's media and setting the machine's settings and state to the state that was saved in the snapshot (if any). This destroys the machine's current state. After calling this, IMachine.getCurrentSnapshot() points to the snapshot that was restored.
  • IConsole.deleteSnapshot(java.lang.String) deletes a snapshot without affecting the current machine state. This does not change the current machine state, but instead frees the resources allocated when the snapshot was taken: the settings and machine state file are deleted (if any), and the snapshot's differencing image for each of the machine's media gets merged with its parent image. Neither the current machine state nor other snapshots are affected by this operation, except that parent media will be modified to contain the disk data associated with the snapshot being deleted. When deleting the current snapshot, the IMachine.getCurrentSnapshot() attribute is set to the current snapshot's parent or null if it has no parent. Otherwise the attribute is unchanged.
Each snapshot contains a copy of virtual machine's settings (hardware configuration etc.). This copy is contained in an immutable (read-only) instance of IMachine which is available from the snapshot's getMachine() attribute. When restoring the snapshot, these settings are copied back to the original machine. In addition, if the machine was running when the snapshot was taken (IMachine.getState() is MachineState.Running), the current VM state is saved in the snapshot (similarly to what happens when a VM's state is saved). The snapshot is then said to be online because when restoring it, the VM will be running. If the machine was in MachineState.Saved saved, the snapshot receives a copy of the execution state file (IMachine.getStateFilePath()). Otherwise, if the machine was not running (MachineState.PoweredOff or MachineState.Aborted), the snapshot is offline; it then contains a so-called "zero execution state", representing a machine that is powered off. Interface ID: {0472823B-C6E7-472A-8E9F-D732E86B8463}
public class ISnapshot extends IUnknown {
    public ISnapshot(String wrappedVboxPortType port) {
          super(wrappedport);
    }
UUID of the snapshot.

Returns:
String
    public String getId() {
      try {
         String retVal = .iSnapshotGetId();
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Short name of the snapshot. NOTE: Setting this attribute causes IMachine.saveSettings() to be called implicitly.

Returns:
String
    public String getName() {
      try {
         String retVal = .iSnapshotGetName();
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Short name of the snapshot. NOTE: Setting this attribute causes IMachine.saveSettings() to be called implicitly.

Parameters:
value String
    public void setName(String value) {
      try {
        .iSnapshotSetName(value);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Optional description of the snapshot. NOTE: Setting this attribute causes IMachine.saveSettings() to be called implicitly.

Returns:
String
    public String getDescription() {
      try {
         String retVal = .iSnapshotGetDescription();
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Optional description of the snapshot. NOTE: Setting this attribute causes IMachine.saveSettings() to be called implicitly.

Parameters:
value String
    public void setDescription(String value) {
      try {
        .iSnapshotSetDescription(value);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.

Returns:
Long
    public Long getTimeStamp() {
      try {
         Long retVal = .iSnapshotGetTimeStamp();
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
true if this snapshot is an online snapshot and false otherwise. When this attribute is true, the IMachine.getStateFilePath() attribute of the getMachine() object associated with this snapshot will point to the saved state file. Otherwise, it will be an empty string.

Returns:
Boolean
    public Boolean getOnline() {
      try {
         Boolean retVal = .iSnapshotGetOnline();
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Virtual machine this snapshot is taken on. This object stores all settings the machine had when taking this snapshot. NOTE: The returned machine object is immutable, i.e. no any settings can be changed.

Returns:
org.virtualbox_4_2.IMachine
      try {
         String retVal = .iSnapshotGetMachine();
         return (retVal.length() > 0) ? new org.virtualbox_4_2.IMachine(retVal) : null;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Parent snapshot (a snapshot this one is based on), or null if the snapshot has no parent (i.e. is the first snapshot).

Returns:
org.virtualbox_4_2.ISnapshot
      try {
         String retVal = .iSnapshotGetParent();
         return (retVal.length() > 0) ? new org.virtualbox_4_2.ISnapshot(retVal) : null;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Child snapshots (all snapshots having this one as a parent). By inspecting this attribute starting with a machine's root snapshot (which can be obtained by calling IMachine.findSnapshot(java.lang.String) with a null UUID), a machine's snapshots tree can be iterated over.

Returns:
List<org.virtualbox_4_2.ISnapshot>
      try {
         List<StringretVal = .iSnapshotGetChildren();
         return Helper.wrap(org.virtualbox_4_2.ISnapshot.classretVal);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
    public static ISnapshot queryInterface(IUnknown obj) {
       return obj == null ?  null : new ISnapshot(obj.getWrapped(), obj.getRemoteWSPort());
    }
Returns the number of direct childrens of this snapshot.
    public Long getChildrenCount() {
      try {
        Long     retVal;
        retVal = .iSnapshotGetChildrenCount();
        return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
New to GrepCode? Check out our FAQ X