java.lang.Process Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.lang;
import java.io.*;
/**
* The Runtime.exec methods create a native process and
* return an instance of a subclass of Process that can
* be used to control the process and obtain information about it.
* The class Process provides methods for performing
* input from the process, performing output to the process, waiting
* for the process to complete, checking the exit status of the process,
* and destroying (killing) the process.
*
* The Runtime.exec methods may not work well for special
* processes on certain native platforms, such as native windowing
* processes, daemon processes, Win16/DOS processes on Microsoft Windows, or shell
* scripts. The created subprocess does not have its own terminal or
* console. All its standard io (i.e. stdin, stdout, stderr) operations
* will be redirected to the parent process through three streams
* (Process.getOutputStream(),
* Process.getInputStream(),
* Process.getErrorStream()).
* The parent process uses these streams to feed input to and get output
* from the subprocess. Because some native platforms only provide
* limited buffer size for standard input and output streams, failure
* to promptly write the input stream or read the output stream of
* the subprocess may cause the subprocess to block, and even deadlock.
*
* The subprocess is not killed when there are no more references to
* the Process object, but rather the subprocess
* continues executing asynchronously.
*
* There is no requirement that a process represented by a Process
* object execute asynchronously or concurrently with respect to the Java
* process that owns the Process object.
*
* @author unascribed
* @version 1.17, 02/02/00
* @see java.lang.Runtime#exec(java.lang.String)
* @see java.lang.Runtime#exec(java.lang.String, java.lang.String[])
* @see java.lang.Runtime#exec(java.lang.String[])
* @see java.lang.Runtime#exec(java.lang.String[], java.lang.String[])
* @since JDK1.0
*/
public abstract class Process
{
public Process() { }
/**
* Gets the output stream of the subprocess.
* Output to the stream is piped into the standard input stream of
* the process represented by this Process object.
*
* Implementation note: It is a good idea for the output stream to
* be buffered.
*
* @return the output stream connected to the normal input of the
* subprocess.
*/
public abstract OutputStream getOutputStream();
/**
* Gets the input stream of the subprocess.
* The stream obtains data piped from the standard output stream
* of the process represented by this Process object.
*
* Implementation note: It is a good idea for the input stream to
* be buffered.
*
* @return the input stream connected to the normal output of the
* subprocess.
*/
public abstract InputStream getInputStream();
/**
* Gets the error stream of the subprocess.
* The stream obtains data piped from the error output stream of the
* process represented by this Process object.
*
* Implementation note: It is a good idea for the input stream to be
* buffered.
*
* @return the input stream connected to the error stream of the
* subprocess.
*/
public abstract InputStream getErrorStream();
/**
* causes the current thread to wait, if necessary, until the
* process represented by this Process object has
* terminated. This method returns
* immediately if the subprocess has already terminated. If the
* subprocess has not yet terminated, the calling thread will be
* blocked until the subprocess exits.
*
* @return the exit value of the process. By convention,
* 0 indicates normal termination.
* @exception InterruptedException if the current thread is
* {@link Thread#interrupt() interrupted} by another thread
* while it is waiting, then the wait is ended and an
* InterruptedException is thrown.
*/
public abstract int waitFor() throws java.lang.InterruptedException;
/**
* Returns the exit value for the subprocess.
*
* @return the exit value of the subprocess represented by this
* Process object. by convention, the value
* 0 indicates normal termination.
* @exception IllegalThreadStateException if the subprocess represented
* by this Process object has not yet terminated.
*/
public abstract int exitValue();
/**
* Kills the subprocess. The subprocess represented by this
* Process object is forcibly terminated.
*/
public abstract void destroy();
}