org.virtualbox_4_3

Enum SessionState

java.lang.Object

java.lang.Enum<SessionState>

org.virtualbox_4_3.SessionState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SessionState>

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

Session state. This enumeration represents possible values of IMachine.getSessionState()and ISession.getState()attributes. Interface ID: {CF2700C0-EA4B-47AE-9725-7810114B94D8}

Enum Constant Summary

Enum Constants

Enum Constant and Description
Locked In IMachine.getSessionState(), this means that the machine is currently locked for a session, whose process identifier can then be found in the IMachine.getSessionPID()attribute.
Null Null value (never used by the API).
Spawning A new process is being spawned for the machine as a result of IMachine.launchVMProcess(org.virtualbox_4_3.ISession,String,String)call.
Unlocked In IMachine.getSessionState(), this means that the machine is not locked for any sessions.
Unlocking The session is being unlocked.

Method Summary

Methods

Modifier and Type	Method and Description
static SessionState	fromValue(long v)
static SessionState	fromValue(java.lang.String v)
int	value()
static SessionState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SessionState[]	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 SessionState Null

Null value (never used by the API).

Unlocked

public static final SessionState Unlocked

In IMachine.getSessionState(), this means that the machine is not locked for any sessions. In ISession.getState(), this means that no machine is currently locked for this session.

Locked

public static final SessionState Locked

In IMachine.getSessionState(), this means that the machine is currently locked for a session, whose process identifier can then be found in the IMachine.getSessionPID()attribute. In ISession.getState(), this means that a machine is currently locked for this session, and the mutable machine object can be found in the ISession.getMachine()attribute (see IMachine.lockMachine(org.virtualbox_4_3.ISession,org.virtualbox_4_3.LockType)for details).

Spawning

public static final SessionState Spawning

A new process is being spawned for the machine as a result of IMachine.launchVMProcess(org.virtualbox_4_3.ISession,String,String)call. This state also occurs as a short transient state during an IMachine.lockMachine(org.virtualbox_4_3.ISession,org.virtualbox_4_3.LockType)call.

Unlocking

public static final SessionState Unlocking

The session is being unlocked.

Method Detail

values

public static SessionState[] 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 (SessionState c : SessionState.values())
    System.out.println(c);

Returns:

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

valueOf

public static SessionState 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 SessionState fromValue(long v)

fromValue

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