ConsoleProcess (JanosRuntime JavaDOC)

java.lang.Object
- java.lang.Process
- - com.integpg.system.ConsoleProcess

```
public class ConsoleProcess
extends Process
```
Provides programmatic access to a Command Console session.

Constructor Summary

Constructors
Constructor and Description
`ConsoleProcess()` Creates a new ConsoleProcess.
`ConsoleProcess(String command)` Creates a new ConsoleProcess.
`ConsoleProcess(String command, Hashtable env)` Creates a new ConsoleProcess.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Closes the console connection and releases associated resources.
`int`	`exitValue()` Obtains the most recent ERRORLEVEL (application return value).
`protected void`	`finalize()` Insures that the session is closed before releasing the object.
`Hashtable`	`getEnvironment()` Returns the current console environment as a Hashtable.
`InputStream`	`getErrorStream()` Creates an InputStream from which you can read output to stderr.
`InputStream`	`getInputStream()` Creates an InputStream from which you can read output to stdout.
`OutputStream`	`getOutputStream()` Creates an OutputStream through which you can enter characters to stdin.
`boolean`	`isAlive()` Queries the status of the console connection.
`boolean`	`isPrompted()` Queries the console input status.
`boolean`	`isReady()` Queries the console input status.
`void`	`killProcess()` Closes the console process.
`int`	`waitFor()` Blocks for console exit.
`void`	`waitPrompt()` Blocks until the command process requests input.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConsoleProcess
```
public ConsoleProcess(String command,
                      Hashtable env)
```
    Creates a new ConsoleProcess. Will execute a command if provided. Inherits the current Environment unless one is specified. Upon completion of the command the console exits. If a command is not provided the session is left at the command line prompt.
    
    Parameters:
    
    command - optional command to be executed
    
    env - optional console environment
  - ConsoleProcess
```
public ConsoleProcess(String command)
```
    Creates a new ConsoleProcess. Will execute a command if provided. Inherits the current Environment. Upon completion of the command the console exits. If a command is not specified the session is left at the command line prompt.
    
    Parameters:
    
    command - optional command to be executed
  - ConsoleProcess
```
public ConsoleProcess()
```
    Creates a new ConsoleProcess. Inherits the current Environment. The command the console is left at the command line prompt.
- Method Detail
  - destroy
```
public void destroy()
```
    Closes the console connection and releases associated resources.
    
    Specified by:
    
    destroy in class Process
  - killProcess
```
public void killProcess()
```
    Closes the console process.
  - isAlive
```
public boolean isAlive()
```
    Queries the status of the console connection.
    
    Specified by:
    
    isAlive in class Process
    
    Returns:
    
    true if the console is still active
  - isPrompted
```
public boolean isPrompted()
```
    Queries the console input status.
    
    Returns:
    
    TRUE if the console process is pending input
    
    Since:
    
    v1.5.1
  - waitPrompt
```
public void waitPrompt()
```
    Blocks until the command process requests input.
    
    Since:
    
    v1.5.1
  - isReady
```
public boolean isReady()
```
    Queries the console input status. Indicates that the console is at the command line prompt requesting the entry of a new command.
    
    Returns:
    
    TRUE if the console process is ready for command input
    
    Since:
    
    v1.5.1
  - exitValue
```
public int exitValue()
              throws IllegalThreadStateException
```
    Obtains the most recent ERRORLEVEL (application return value).
    
    Specified by:
    
    exitValue in class Process
    
    Returns:
    
    errorlevel
    
    Throws:
    
    IllegalThreadStateException - if the console is not active
  - getErrorStream
```
public InputStream getErrorStream()
```
    Creates an InputStream from which you can read output to stderr.
    
    Specified by:
    
    getErrorStream in class Process
    
    Returns:
    
    InputStream object
  - getInputStream
```
public InputStream getInputStream()
```
    Creates an InputStream from which you can read output to stdout.
    
    Specified by:
    
    getInputStream in class Process
    
    Returns:
    
    InputStream
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Creates an OutputStream through which you can enter characters to stdin.
    
    Specified by:
    
    getOutputStream in class Process
    
    Returns:
    
    OutputStream
  - getEnvironment
```
public Hashtable getEnvironment()
```
    Returns the current console environment as a Hashtable.
    
    Returns:
    
    environment hashtable
  - waitFor
```
public int waitFor()
            throws InterruptedException
```
    Blocks for console exit.
    
    Specified by:
    
    waitFor in class Process
    
    Returns:
    
    errorlevel value returned by the process
    
    Throws:
    
    InterruptedException - if interrupted before exit
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Insures that the session is closed before releasing the object.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - on any exception

Class ConsoleProcess

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsoleProcess

ConsoleProcess

ConsoleProcess

Method Detail

destroy

killProcess

isAlive

isPrompted

waitPrompt

isReady

exitValue

getErrorStream

getInputStream

getOutputStream

getEnvironment

waitFor

finalize