Package org.libvirt

Class DomainCheckpoint

java.lang.Object

org.libvirt.DomainCheckpoint

public class DomainCheckpoint
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DomainCheckpoint.CheckpointDeleteFlags
static final class	DomainCheckpoint.XMLFlags

Constructor Summary

Constructors

Constructor	Description
DomainCheckpoint(Connect virConnect, DomainCheckpointPointer vdcp)	Constructs a DomainCheckpoint object from a known native DomainCheckpointPointer, and a Connect object.

Method Summary

Modifier and Type	Method	Description
int	delete(int flags)	Delete the domain checkpoint
protected void	finalize()
int	free()	Frees this domaincheckpoint object.
String	getName()	Get the public name for that checkpoint
DomainCheckpoint	getParent()	Get the parent checkpoint for checkpoint, if any.
DomainCheckpoint	getParent(int flags)	Get the parent checkpoint for checkpoint, if any.
String	getXMLDesc()	Fetches an XML document describing attributes of the domain checkpoint, without security-sensitive data.
String	getXMLDesc(int flags)	Fetches an XML document describing attributes of the domain checkpoint.
DomainCheckpoint[]	listAllChildren(int flags)	Array of domain checkpoints children for the given domain checkpoint.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DomainCheckpoint

public DomainCheckpoint(Connect virConnect,
 DomainCheckpointPointer vdcp)

Constructs a DomainCheckpoint object from a known native DomainCheckpointPointer, and a Connect object.

Parameters:

virConnect - the Domain's hypervisor

vdcp - the native virDomainCheckpointPtr

Method Details

delete

public int delete(int flags)
           throws LibvirtException

Delete the domain checkpoint

Parameters:

flags - see DomainCheckpoint.CheckpointDeleteFlags controls the deletion

Returns:

ignore (always 0)

Throws:

LibvirtException

See Also:

• Libvirt Documentation

finalize

protected void finalize()
                 throws LibvirtException

Overrides:

finalize in class Object

Throws:

LibvirtException

free

public int free()
         throws LibvirtException

Frees this domaincheckpoint object. The running instance is kept alive. The data structure is freed and should not be used thereafter.

Returns:

number of references left (>= 0)

Throws:

LibvirtException

getXMLDesc

public String getXMLDesc()
                  throws LibvirtException

Fetches an XML document describing attributes of the domain checkpoint, without security-sensitive data.

Returns:

the XML document

Throws:

LibvirtException

See Also:

• Libvirt Documentation

getXMLDesc

public String getXMLDesc(int flags)
                  throws LibvirtException

Fetches an XML document describing attributes of the domain checkpoint.

Parameters:

flags - see DomainCheckpoint.XMLFlags controls the information

Returns:

the XML document

Throws:

LibvirtException

See Also:

• Libvirt Documentation

getName

public String getName()
               throws LibvirtException

Get the public name for that checkpoint

Returns:

the name, null if there is no name

Throws:

LibvirtException

listAllChildren

public DomainCheckpoint[] listAllChildren(int flags)
                                   throws LibvirtException

Array of domain checkpoints children for the given domain checkpoint.

Parameters:

flags - flags for list the checkpoints, see the Domain.CheckpointListFlags for the flag options

Returns:

Array with children checkpoints of the given domain checkpoint

Throws:

LibvirtException

See Also:

• Libvirt Documentation

getParent

public DomainCheckpoint getParent(int flags)
                           throws LibvirtException

Get the parent checkpoint for checkpoint, if any.

Parameters:

flags - extra flags

Returns:

a domain checkpoint or null if the given domain checkpoint is root

Throws:

LibvirtException

See Also:

• Libvirt Documentation

getParent

public DomainCheckpoint getParent()
                           throws LibvirtException

Get the parent checkpoint for checkpoint, if any. This is just a convenience method, it has the same effect as calling getParent(0);.

Returns:

a domain checkpoint or null if the given domain checkpoint is root

Throws:

LibvirtException

See Also:

• getParent(int)
• Libvirt Documentation