org.virtualbox_5_0
Enum LockType

java.lang.Object
  extended by java.lang.Enum<LockType>
      extended by org.virtualbox_5_0.LockType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<LockType>

public enum LockType
extends java.lang.Enum<LockType>

Used withIMachine.lockMachine(org.virtualbox_5_0.ISession,org.virtualbox_5_0.LockType). Interface ID: {678AAF14-2815-4C3E-B20A-E86ED0216498}


Enum Constant Summary
Null
          Placeholder value, do not use when obtaining a lock.
Shared
          Request only a shared lock for remote-controlling the machine.
VM
          Lock the machine for writing, and create objects necessary for running a VM in this process.
Write
          Lock the machine for writing.
 
Method Summary
static LockType fromValue(long v)
           
static LockType fromValue(java.lang.String v)
           
 int value()
           
static LockType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static LockType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Null

public static final LockType Null
Placeholder value, do not use when obtaining a lock.


Shared

public static final LockType Shared
Request only a shared lock for remote-controlling the machine. Such a lock allows changing certain VM settings which can be safely modified for a running VM.


Write

public static final LockType Write
Lock the machine for writing. This requests an exclusive lock, i.e. there cannot be any other API client holding any type of lock for this VM concurrently. Remember that a VM process counts as an API client which implicitly holds the equivalent of a shared lock during the entire VM runtime.


VM

public static final LockType VM
Lock the machine for writing, and create objects necessary for running a VM in this process.

Method Detail

values

public static LockType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (LockType c : LockType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static LockType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

value

public int value()

fromValue

public static LockType fromValue(long v)

fromValue

public static LockType fromValue(java.lang.String v)