Класс Process

public Process()

public abstract OutputStream getOutputStream()

API Note:

При записи в getOutputStream() и в outputWriter() или outputWriter(Charset), следует вызвать BufferedWriter.flush перед записью в OutputStream.

Implementation Note:

Реализация: Рекомендуется буферизовать возвращаемый поток вывода.

Returns:

поток вывода, подключенный к стандартному вводу процесса

public abstract InputStream getInputStream()

API Note:

Используйте getInputStream() и inputReader() с осторожностью. BufferedReader может буферизовать ввод из потока.

Implementation Note:

Реализация: Рекомендуется буферизовать возвращаемый поток ввода.

Returns:

поток ввода, подключенный к стандартному выводу процесса

public abstract InputStream getErrorStream()

API Note:

Используйте getErrorStream() и errorReader() с осторожностью. BufferedReader может буферизовать ввод из потока ошибок.

Implementation Note:

Реализация: Рекомендуется буферизовать возвращаемый поток ввода.

Returns:

поток ввода, подключенный к выводу ошибок процесса

public final BufferedReader inputReader()

Returns:

BufferedReader, использующий native.encoding, если поддерживается, в противном случае Charset.defaultCharset()

Since:

17

public final BufferedReader inputReader(Charset charset)

API Note:

Использование как getInputStream(), так и inputReader(Charset) приводит к непредсказуемому поведению, так как буферизованный читатель читает вперёд из потока ввода.

После завершения процесса и при отсутствии перенаправления стандартного ввода, чтение доступных байтов из базового потока выполняется в лучшем возможном режиме и может быть непредсказуемым.

Parameters:

charset - Charset, используемый для декодирования байтов в символы

Returns:

BufferedReader для стандартного вывода процесса, используя charset

Throws:

NullPointerException - если charset null

IllegalStateException - если вызывается более одного раза с разными аргументами кодировки

Since:

17

public final BufferedReader errorReader()

Returns:

BufferedReader, использующий native.encoding, если поддерживается, в противном случае Charset.defaultCharset()

Since:

17

public final BufferedReader errorReader(Charset charset)

API Note:

Использование и getErrorStream() и errorReader(Charset) приводит к непредсказуемому поведению, так как буферизованный читатель считывает данные из потока ошибок предварительно.

После завершения процесса и при отсутствии перенаправления стандартного потока ошибок, чтение доступных байтов из базового потока выполняется по принципу «лучше, чем ничего», и может быть непредсказуемым.

Parameters:

charset - Charset для декодирования байтов в символы

Returns:

BufferedReader для стандартного потока ошибок процесса, используя charset

Throws:

NullPointerException - если charset является null

IllegalStateException - если вызывается более одного раза с разными аргументами charset

Since:

17

public final BufferedWriter outputWriter()

Returns:

BufferedWriter для стандартного входного потока процесса, используя кодировку для native.encoding свойства системы

Since:

17

public final BufferedWriter outputWriter(Charset charset)

API Note:

BufferedWriter пишет символы, массивы символов и строки. Обертывание BufferedWriter с помощью PrintWriter обеспечивает эффективную буферизацию и форматирование примитивов и объектов, а также поддержку автоматической очистки по окончанию строк. Вызовите метод BufferedWriter.flush() для очистки буферизованного вывода в процесс.

При записи в оба getOutputStream() и либо outputWriter(), либо outputWriter(Charset), необходимо вызвать BufferedWriter.flush() перед записью в OutputStream.

Parameters:

charset - Charset для кодирования символов в байты

Returns:

BufferedWriter для стандартного входного потока процесса, используя charset

Throws:

NullPointerException - если charset является null

IllegalStateException - если вызывается более одного раза с разными аргументами charset

Since:

17

public abstract int waitFor() throws InterruptedException

Returns:

значение выхода процесса, представленного этим Process объектом. По соглашению, значение 0 указывает на нормальное завершение.

Throws:

InterruptedException - если текущая нить прерывается другой нитью во время ожидания, ожидание завершается, и выбрасывается исключение InterruptedException.

public boolean waitFor(long timeout, TimeUnit unit) throws InterruptedException

Implementation Requirements:

Предпочтительная реализация этого метода опрашивает exitValue, чтобы проверить, завершился ли процесс.

Implementation Note:

Конкретные реализации этого класса настоятельно рекомендуют переопределить этот метод с более эффективной реализацией.

Parameters:

timeout - максимальное время ожидания

unit - единица измерения времени для аргумента timeout

Returns:

true, если процесс завершился, и false, если время ожидания истекло до завершения процесса.

Throws:

InterruptedException - если текущая нить прерывается во время ожидания.

NullPointerException - если unit равен null

Since:

1.8

public boolean waitFor(Duration duration) throws InterruptedException

Implementation Requirements:

Предпочтительная реализация этого метода опрашивает exitValue, чтобы проверить, завершился ли процесс.

Implementation Note:

Конкретные реализации этого класса настоятельно рекомендуют переопределить этот метод с более эффективной реализацией.

Parameters:

duration - максимальное время ожидания; если не положительно, этот метод возвращается немедленно.

Returns:

true, если процесс завершился, и false, если время ожидания истекло до завершения процесса.

Throws:

InterruptedException - если текущая нить прерывается во время ожидания.

NullPointerException - если duration равно null

Since:

24

public abstract int exitValue()

Returns:

значение выхода процесса, представленного этим Process объектом. По соглашению, значение 0 указывает на нормальное завершение.

Throws:

IllegalThreadStateException - если процесс, представленный этим Process объектом, еще не завершен

public abstract void destroy()

public Process destroyForcibly()

API Note:

Процесс может не завершиться немедленно. т.е. isAlive() может вернуть true в течение короткого периода после вызова destroyForcibly(). Этот метод можно использовать последовательно с waitFor(), если это необходимо.

Implementation Requirements:

Реализация по умолчанию этого метода вызывает destroy(), поэтому может не принудительно завершать процесс.

Implementation Note:

Конкретным реализациям этого класса настоятельно рекомендуется переопределить этот метод с соответствующей реализацией.

Returns:

объект Process, представляющий принудительно уничтоженный процесс

Since:

1.8

public boolean supportsNormalTermination()

Implementation Requirements:

Эта реализация выбрасывает экземпляр UnsupportedOperationException и не выполняет никаких других действий.

Returns:

true, если реализация destroy() должна нормально завершить процесс; в противном случае destroy() принудительно завершает процесс

Throws:

UnsupportedOperationException - если реализация процесса не поддерживает эту операцию

Since:

9

public boolean isAlive()

Returns:

true, если процесс, представленный этим Process объектом, еще не завершился.

Since:

1.8

public long pid()

Implementation Requirements:

Реализация этого метода возвращает идентификатор процесса как: toHandle().pid().

Returns:

системный идентификатор процесса

Throws:

UnsupportedOperationException - если реализация процесса не поддерживает эту операцию

Since:

9

public CompletableFuture<Process> onExit()

API Note:

Использование onExit — это альтернатива waitFor, которая позволяет добавить дополнительную конкурентность и удобный доступ к результату процесса. Для вычисления результата выполнения процесса можно использовать лямбда-выражения. Если перед использованием значения необходимо выполнить другую обработку, то onExit — удобный механизм для освобождения текущей нити и блокирования только при необходимости значения.
Например, запуск процесса для сравнения двух файлов и получения булевого значения, если они идентичны:

   Process p = new ProcessBuilder("cmp", "f1", "f2").start();
    Future<Boolean> identical = p.onExit().thenApply(p1 -> p1.exitValue() == 0);
    ...
    if (identical.get()) { ... }
 

, процесс может быть отмечен как завершенный с помощью isAlive() до завершения ComputableFuture и вызова зависимых действий.

Implementation Requirements:

Эта реализация выполняет waitFor() в отдельной нити повторно до тех пор, пока она не выполнится успешно. Если выполнение waitFor прерывается, состояние прерывания нити сохраняется.

При успешном выполнении waitFor() CompletableFuture завершается независимо от кода завершения процесса. Эта реализация может потреблять много памяти для стеков потоков, если для большого количества процессов ожидается одновременное выполнение.

Внешние реализации должны переопределить этот метод и обеспечить более эффективную реализацию. Например, для делегирования подлежащему процессу можно сделать следующее:

    public CompletableFuture<Process> onExit() {
       return delegate.onExit().thenApply(p -> this);
    }
 

Returns:

новый CompletableFuture<Process> для процесса

Since:

9

public ProcessHandle toHandle()

Implementation Requirements:

Эта реализация выбрасывает экземпляр UnsupportedOperationException и не выполняет никаких других действий. Подклассы должны переопределить этот метод, чтобы предоставить ProcessHandle для процесса. Методы pid(), info(), children() и descendants(), если не переопределены, работают с ProcessHandle.

Returns:

Возвращает ProcessHandle для процесса

Throws:

UnsupportedOperationException - если реализация процесса не поддерживает эту операцию

Since:

9

public ProcessHandle.Info info()

Implementation Requirements:

Эта реализация возвращает информацию о процессе как: toHandle().info().

Returns:

моментальный снимок информации о процессе, всегда не null

Throws:

UnsupportedOperationException - если реализация процесса не поддерживает эту операцию

Since:

9

public Stream<ProcessHandle> children()

Implementation Requirements:

Эта реализация возвращает прямых дочерних процессов как: toHandle().children().

Returns:

последовательная Stream объектов ProcessHandles для процессов, которые являются прямыми дочерними процессами

Throws:

UnsupportedOperationException - если реализация процесса не поддерживает эту операцию

Since:

9

public Stream<ProcessHandle> descendants()

Требования к реализации:

Эта реализация возвращает всех детей как: toHandle().descendants().

Возвращает:

последовательную Stream объектов ProcessHandles для процессов, которые являются потомками процесса

Выбрасывает:

UnsupportedOperationException — если реализация Process не поддерживает эту операцию

С:

9