Класс Process

public Process()

public abstract OutputStream getOutputStream()

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

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

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

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

Возвращает:

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

public abstract InputStream getInputStream()

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

Для одного и того же Process используйте либо этот метод, либо средство чтения входных данных, но не оба сразу. Средство чтения входных данных считывает и буферизует байты из входного потока. Байты, считанные из входного потока, не будут доступны средству чтения, а содержимое буфера будет непредсказуемым.

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

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

Возвращает:

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

public abstract InputStream getErrorStream()

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

Для одного и того же Process используйте либо этот метод, либо средство чтения потока ошибок, но не оба сразу. Средство чтения потока ошибок считывает и буферизует байты из потока ошибок. Байты, считанные из потока ошибок, не будут доступны средству чтения, а содержимое буфера будет непредсказуемым.

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

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

Возвращает:

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

public final BufferedReader inputReader()

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

Для одного и того же Process используйте либо этот метод, либо входной поток, но не оба сразу. Средство чтения входных данных считывает и буферизует байты из входного потока. Байты, считанные из входного потока, не будут доступны средству чтения, а содержимое буфера будет непредсказуемым.

Возвращает:

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

Начиная с версии:

17

public final BufferedReader inputReader(Charset charset)

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

Для одного и того же Process используйте либо этот метод, либо входной поток, но не оба сразу. Средство чтения входных данных считывает и буферизует байты из входного потока. Байты, считанные из входного потока, не будут доступны средству чтения, а содержимое буфера будет непредсказуемым.

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

Параметры:

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

Возвращает:

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

Вызывает:

NullPointerException — если charset равно null

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

Начиная с версии:

17

public final BufferedReader errorReader()

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

Для одного и того же Process используйте либо этот метод, либо поток ошибок, но не оба сразу. Средство чтения потока ошибок считывает и буферизует байты из потока ошибок. Байты, считанные из потока ошибок, не будут доступны средству чтения, а содержимое буфера будет непредсказуемым.

Возвращает:

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

Начиная с версии:

17

public final BufferedReader errorReader(Charset charset)

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

Для одного и того же Process используйте либо этот метод, либо поток ошибок, но не оба сразу. Средство чтения потока ошибок считывает и буферизует байты из потока ошибок. Байты, считанные из потока ошибок, не будут доступны средству чтения, а содержимое буфера будет непредсказуемым.

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

Параметры:

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

Возвращает:

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

Вызывает:

NullPointerException — если charset равно null

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

Начиная с версии:

17

public final BufferedWriter outputWriter()

Возвращает:

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

Начиная с версии:

17

public final BufferedWriter outputWriter(Charset charset)

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

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

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

Параметры:

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

Возвращает:

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

Вызывает:

NullPointerException — если charset равно null

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

Начиная с версии:

17

public abstract int waitFor() throws InterruptedException

Возвращает:

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

Вызывает:

InterruptedException — если другой поток прерывает текущий поток во время ожидания, ожидание прекращается и выбрасывается InterruptedException.

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

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

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

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

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

Параметры:

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

unit — единица измерения аргумента timeout

Возвращает:

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

Вызывает:

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

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

Начиная с версии:

1.8

public boolean waitFor(Duration duration) throws InterruptedException

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

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

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

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

Параметры:

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

Возвращает:

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

Вызывает:

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

NullPointerException — если duration равен null

Начиная с версии:

24

public abstract int exitValue()

Возвращает:

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

Вызывает:

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

public abstract void destroy()

public Process destroyForcibly()

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

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

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

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

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

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

Возвращает:

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

Начиная с версии:

1.8

public boolean supportsNormalTermination()

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

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

Возвращает:

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

Вызывает:

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

Начиная с версии:

9

public boolean isAlive()

Возвращает:

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

Начиная с версии:

1.8

public long pid()

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

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

Возвращает:

идентификатор собственного процесса

Вызывает:

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

Начиная с версии:

9

public CompletableFuture<Process> onExit()

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

Использование onExit — это альтернатива waitFor, которая обеспечивает дополнительную параллельность и удобный доступ к результату выполнения Process. Лямбда-выражения можно использовать для вычисления результата выполнения Process. Если перед использованием значения необходимо выполнить другие действия, 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> для Process

Начиная с версии:

9

public ProcessHandle toHandle()

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

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

Возвращает:

Возвращает ProcessHandle для Process

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

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

Начиная с версии:

9

public ProcessHandle.Info info()

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

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

Возвращает:

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

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

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

Начиная с версии:

9

public Stream<ProcessHandle> children()

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

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

Возвращает:

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

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

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

Начиная с версии:

9

public Stream<ProcessHandle> descendants()

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

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

Возвращает:

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

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

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

Начиная с версии:

9