org.virtualbox_4_3
Enum ProcessWaitResult

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

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

Process waiting results. Depending on the process waiting flags (for more information see ProcessWaitForFlag) the waiting result can vary based on the processes' current status. To wait for a guest process to terminate after it has been created by IGuestSession.processCreate(String,List,List,List,Long)or IGuestSession.processCreateEx(String,List,List,List,Long,org.virtualbox_4_3.ProcessPriority,List)one would specify ProcessWaitResult_Terminate. If a guest process has been started with ProcessCreateFlag_WaitForStdOut a client can wait with ProcessWaitResult_StdOut for new data to arrive on stdout; same applies for ProcessCreateFlag_WaitForStdErr and ProcessWaitResult_StdErr. Interface ID: {40719CBE-F192-4FE9-A231-6697B3C8E2B4}


Enum Constant Summary
Error
          Error while executing the process.
None
          No result was returned.
Start
          The process has been started.
Status
          The process has changed its status.
StdErr
          Data on stderr became available for reading.
StdIn
          The process signalled that stdin became available for writing and that the process awaits input now.
StdOut
          Data on stdout became available for reading.
Terminate
          The process has been terminated.
Timeout
          The waiting operation timed out.
WaitFlagNotSupported
          A waiting flag specified in the IProcess.waitFor(Long,Long)call is not supported by the guest.
 
Method Summary
static ProcessWaitResult fromValue(long v)
           
static ProcessWaitResult fromValue(java.lang.String v)
           
 int value()
           
static ProcessWaitResult valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ProcessWaitResult[] 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

None

public static final ProcessWaitResult None
No result was returned. Not being used.


Start

public static final ProcessWaitResult Start
The process has been started.


Terminate

public static final ProcessWaitResult Terminate
The process has been terminated.


Status

public static final ProcessWaitResult Status
The process has changed its status. The status then can be retrieved via IProcess.getStatus().


Error

public static final ProcessWaitResult Error
Error while executing the process.


Timeout

public static final ProcessWaitResult Timeout
The waiting operation timed out. This also will happen when no event has been occurred matching the current waiting flags in a IProcess.waitFor(Long,Long)call.


StdIn

public static final ProcessWaitResult StdIn
The process signalled that stdin became available for writing and that the process awaits input now.


StdOut

public static final ProcessWaitResult StdOut
Data on stdout became available for reading.


StdErr

public static final ProcessWaitResult StdErr
Data on stderr became available for reading.


WaitFlagNotSupported

public static final ProcessWaitResult WaitFlagNotSupported
A waiting flag specified in the IProcess.waitFor(Long,Long)call is not supported by the guest.

Method Detail

values

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

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

valueOf

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

fromValue

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