Класс Process

Process

public Process()

getOutputStream

public abstract OutputStream getOutputStream()

Примечание API:

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

Примечание реализации:

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

Возвращает:

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

getInputStream

public abstract InputStream getInputStream()

Примечание API:

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

Примечание реализации:

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

Возвращает:

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

getErrorStream

public abstract InputStream getErrorStream()

Примечание API:

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

Примечание реализации:

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

Возвращает:

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

inputReader

public final BufferedReader inputReader()

Возвращает:

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

С:

17

inputReader

public final BufferedReader inputReader(Charset charset)

Примечание API:

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

С:

17

errorReader

public final BufferedReader errorReader()

Возвращает:

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

С:

17

errorReader

public final BufferedReader errorReader(Charset charset)

Примечание API:

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

С:

17

outputWriter

public final BufferedWriter outputWriter()

Возвращает:

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

С:

17

outputWriter

public final BufferedWriter outputWriter(Charset charset)

Примечание API:

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

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

Параметры:

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

Возвращает:

объект BufferedWriter к стандартному вводу процесса, используя указанную charset

Исключения:

NullPointerException - если указанная кодировка charset null

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

С:

17

waitFor

public abstract int waitFor() throws InterruptedException

Возвращает:

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

Исключения:

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

waitFor

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

Параметры:

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

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

Возвращает:

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

Исключения:

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

NullPointerException - если единица измерения null

С:

1.8

exitValue

public abstract int exitValue()

Возвращает:

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

Исключения:

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

destroy

public abstract void destroy()

destroyForcibly

public Process destroyForcibly()

Примечание API:

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

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

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

Примечание реализации:

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

Возвращает:

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

С:

1.8

supportsNormalTermination

public boolean supportsNormalTermination()

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

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

Возвращает:

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

Исключения:

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

С:

9

isAlive

public boolean isAlive()

Возвращает:

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

С:

1.8

pid

public long pid()

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

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

Возвращает:

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

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

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

С момента:

9

onExit

public CompletableFuture<Process> onExit()

Примечание API:

Использование 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 и вызова зависимых действий.

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

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

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

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

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

Возвращает:

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

С момента:

9

toHandle

public ProcessHandle toHandle()

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

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

Возвращает:

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

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

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

SecurityException - если установлен менеджер безопасности и он запрещает RuntimePermission("manageProcess")

С момента:

9

info

public ProcessHandle.Info info()

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

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

Возвращает:

снимок информации о процессе, всегда не null

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

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

С момента:

9

children

public Stream<ProcessHandle> children()

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

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

Возвращает:

потоковый Stream объектов ProcessHandles для процессов, являющихся прямыми потомками процесса

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

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

SecurityException - если установлен менеджер безопасности и он запрещает RuntimePermission("manageProcess")

С момента:

9

descendants

public Stream<ProcessHandle> descendants()

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

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

Возвращает:

потоковый Stream объектов ProcessHandles для процессов, являющихся потомками процесса

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

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

SecurityException - если установлен менеджер безопасности и он запрещает RuntimePermission("manageProcess")

С момента:

9