|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD | |||||||
java.lang.Objectjava.lang.Enum<SessionState>
org.virtualbox_5_1.SessionState
public enum SessionState
Session state. This enumeration represents possible values ofIMachine.getSessionState()andISession.getState()attributes.
Interface ID: {CF2700C0-EA4B-47AE-9725-7810114B94D8}
| Enum Constant Summary | |
|---|---|
Locked
In IMachine.getSessionState(), this means that the machine
is currently locked for a session, whose process identifier can
then be found in theIMachine.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_5_1.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 | |
|---|---|
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 |
|---|
public static final SessionState Null
public static final SessionState Unlocked
IMachine.getSessionState(), this means that the machine
is not locked for any sessions.
InISession.getState(), this means that no machine is
currently locked for this session.
public static final SessionState Locked
IMachine.getSessionState(), this means that the machine
is currently locked for a session, whose process identifier can
then be found in theIMachine.getSessionPID()attribute.
InISession.getState(), this means that a machine is
currently locked for this session, and the mutable machine object
can be found in theISession.getMachine()attribute
(seeIMachine.lockMachine(org.virtualbox_5_1.ISession,org.virtualbox_5_1.LockType)for details).
public static final SessionState Spawning
IMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)call. This state also occurs
as a short transient state during anIMachine.lockMachine(org.virtualbox_5_1.ISession,org.virtualbox_5_1.LockType)call.
public static final SessionState Unlocking
| Method Detail |
|---|
public static SessionState[] values()
for (SessionState c : SessionState.values()) System.out.println(c);
public static SessionState valueOf(java.lang.String name)
name - the name of the enum constant to be returned.
java.lang.IllegalArgumentException - if this enum type has no constant
with the specified name
java.lang.NullPointerException - if the argument is nullpublic int value()
public static SessionState fromValue(long v)
public static SessionState fromValue(java.lang.String v)
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD | |||||||