Класс Process

public Process()

public void close() throws IOException

Определено в:

close в интерфейсе AutoCloseable

Определено в:

close в интерфейсе Closeable

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

Пример использования try-with-resources для записи текста в процесс, чтения ответа и закрытия потоков и процесса:

void main() {
    try (Process p = new ProcessBuilder("cat").start();
         var writer = p.outputWriter();
         var reader = p.inputReader()) {
        writer.write(haiku);
        writer.close();
        // Read all lines and print each
        reader.readAllLines()
                .forEach(IO::println);
        var status = p.waitFor();
        if (status != 0)
            throw new RuntimeException("unexpected process status: " + status);
    } catch (Exception e) {
        System.out.println("Process failed: " + e);
    }
}

static final String haiku = """
            Oh, the sunrise glow;
            Paddling with the river flow;
            Chilling still, go slow.
            """;

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

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

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

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

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

IOException — если при закрытии любого из потоков возникает исключение

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

26

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 — если метод вызван более одного раза с разными аргументами кодировки

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

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 — если метод вызван более одного раза с разными аргументами кодировки

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

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 — если метод вызван более одного раза с разными аргументами кодировки

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

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