Класс 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() с осторожностью. BufferedReader может иметь буферизованный ввод из потока ввода.

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

Для возвращаемого потока ввода рекомендуется буферизация.

Возвращает:

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

getErrorStream

public abstract InputStream getErrorStream()

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

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

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

Для возвращаемого потока ввода рекомендуется буферизация.

Возвращает:

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

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

Since:

17

outputWriter

public final BufferedWriter outputWriter(Charset charset)

API Note:

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

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

Параметры:

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

Возвращает:

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

Исключение:

NullPointerException - если указанная charset null

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

Since:

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

Возвращает:

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

Исключение:

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

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

Since:

1.8

exitValue

public abstract int exitValue()

Возвращает:

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

Исключение:

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

destroy

public abstract void destroy()

destroyForcibly

public Process destroyForcibly()

API Note:

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

Implementation Requirements:

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

Implementation Note:

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

Возвращает:

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

Since:

1.8

supportsNormalTermination

public boolean supportsNormalTermination()

Implementation Requirements:

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

Возвращает:

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

Исключение:

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

Since:

9

isAlive

public boolean isAlive()

Возвращает:

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

Since:

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() до того, как CompletableFuture завершит выполнение и будут вызваны зависимые действия.

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

Эта реализация выполняет 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().

Возвращает:

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

Исключение:

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

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

С версии:

9

descendants

public Stream<ProcessHandle> descendants()

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

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

Возвращает:

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

Исключение:

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

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

С версии:

9