ProcUtil (root 0.2-SNAPSHOT API)

java.lang.Object
- xyz.cofe.ipc.process.ProcUtil

```
public class ProcUtil
extends Object
```
Вспомагательный класс по работе с процессами

Author:

GoCha

Constructor Summary

Constructors
Constructor and Description

ProcUtil()

Constructors
Constructor and Description
`ProcUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addExceptionListenr(ExceptionListener listener)` Добаляет слушателя исключений
`static Process`	`exec(String command)` Запускает процесс
`static Process`	`exec(String[] command)` Запускает процесс
`static Process`	`exec(String[] command, String[] env)` Запускает процесс
`static Process`	`exec(String[] command, String[] env, File dir)` Запускает процесс
`static Process`	`exec(String command, String[] env)` Запускает процесс
`static Process`	`exec(String command, String[] env, File dir)` Запускает процесс
`static ProcessResult`	`execQuery(String command)` Выполняет процесс и возвращает прочитанные данные
`static ProcessResult`	`execQuery(String command, String[] env, File workdir)` Выполняет процесс и возвращает прочитанные данные
`static ProcessResult`	`execQuery(String command, String[] env, File workdir, long maxExecProcMSec, String procInput)` Выполняет процесс (shell) и возвращает прочитанные данные
`static ProcessResult`	`execQuery(String command, String[] env, File workdir, long maxExecProcMSec, String procInput, Charset inStreamCS, Charset outStreamCS, int soutBufferLength, long waitReadSOutMSec, Charset errorStreamCS, int serrBufferLength, long waitReadSErrMSec)` Выполняет процесс (shell) и возвращает прочитанные данные
`static ProcessResult`	`execQuery(String command, String[] env, File workdir, String procInput)` Выполняет процесс и возвращает прочитанные данные
`protected static void`	`fireException(Exception exception)`
`static Charset`	`getDefaultCharset()` Возвращает кодировку по умолчанию
`static Integer`	`getErrorsBufferLength()` Возвращает длину буфера ошибок (символы)
`static Charset`	`getErrorsCharset()` Возвращает кодировку потока ошибок
`static Charset`	`getInputCharset()` Возвращает кодировку входного потока
`static Long`	`getMaxExecuteProcessTime()` Возвращает максимальное допустимое время выполнения процесса в миллисекундах
`static Integer`	`getOutputBufferLength()` Возвращает длину буфера стандартного потока данных (символы)
`static Charset`	`getOutputCharset()` Возвращает кодировку стандартного потока данных
`static Long`	`getRepeatCheckWindow()` Возвращает время через которое проверять завершение процесса
`static Boolean`	`getUnionOutputAndErrors()` Возвращает объединять поток ошибок и стандартный поток (в стандартный)
`static Long`	`getWaitReadErrorsWindow()` Возвращает время через которое проверять наличии данных в потоке stderr (0 - без задержки)
`static Long`	`getWaitReadOutputWindow()` Возвращает время через которое проверять наличии данных в потоке stdout (0 - без задержки)
`static void`	`removeExceptionListener(ExceptionListener listener)` Удаляет слушателя исключений
`static Thread`	`runProcessExitListener(Process proc, ProcessListener listener, SyncFlag exitFlag)` Запускает слушаетля процесса в отдельном фоновом потоке, для ожидания завершения процесса.
`static Thread`	`runProcessReaderListener(Process proc, ProcessListener listener, InputStream dataStream, int bufferSize, SyncFlag exitFlag)` Запускает слушаетля процесса в отдельном фоновом потоке, для получения входных данных Поток завершит прослушивание в случае, если процесс перестанет существовать или будет установлен флаг в значени true
`static Thread`	`runProcessReaderListener(Process proc, ProcessListener listener, InputStream dataStream, SyncFlag exitFlag)` Запускает слушаетля процесса в отдельном фоновом потоке, для получения входных данных Поток завершит прослушивание в случае, если процесс перестанет существовать или будет установлен флаг в значени true
`static void`	`setDefaultCharset(Charset defaultCharset)` Устанавливает кодировку по умолчанию
`static void`	`setErrorsBufferLength(Integer errorsBufferLength)` Устанавливает длину буфера ошибок (символы)
`static void`	`setErrorsCharset(Charset errorsCharset)` Устанавливает кодировку потока ошибок
`static void`	`setInputCharset(Charset inputCharset)` Устанавливает кодировку входного потока
`static void`	`setMaxExecuteProcessTime(Long maxExecuteProcessTime)` Устанавливает максимальное допустимое время выполнения процесса в миллисекундах
`static void`	`setOutputBufferLength(Integer outputBufferLength)` Устанавливает длину буфера стандартного потока данных (символы)
`static void`	`setOutputCharset(Charset outputCharset)` Устанавливает кодировку стандартного потока данных
`static void`	`setRepeatCheckWindow(Long repeatCheckWindow)` Устанавливает время через которое проверять завершение процесса
`static void`	`setUnionOutputAndErrors(Boolean unionOutputAndErrors)` Устанавливает объединять поток ошибок и стандартный поток (в стандартный)
`static void`	`setWaitReadErrorsWindow(Long waitReadErrorsWindow)` Устанавливает время через которое проверять наличии данных в потоке stderr (0 - без задержки)
`static void`	`setWaitReadOutputWindow(Long waitReadOutputWindow)` Устанавливает время через которое проверять наличии данных в потоке stdout (0 - без задержки)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProcUtil
```
public ProcUtil()
```
- Method Detail
  - exec
```
public static Process exec(String command)
                    throws IOException
```
    Запускает процесс
    
    Parameters:
    
    command - Команда запуска
    
    Returns:
    
    Процесс
    
    Throws:
    
    IOException - Ошибка i/o, (файл не существует или нет доступа, др...)
  - exec
```
public static Process exec(String[] command)
                    throws IOException
```
    Запускает процесс
    
    Parameters:
    
    command - Массив (первый элемент - имя файла, последующие параметры)
    
    Returns:
    
    Процесс
    
    Throws:
    
    IOException - Ошибка i/o, (файл не существует или нет доступа, др...)
  - exec
```
public static Process exec(String command,
                           String[] env)
                    throws IOException
```
    Запускает процесс
    
    Parameters:
    
    command - Команда запуска
    
    env - Переменные окружения процесса, где каждая строка является парой имя_перменной=значение
    
    Returns:
    
    Процесс
    
    Throws:
    
    IOException - Ошибка i/o, (файл не существует или нет доступа, др...)
  - exec
```
public static Process exec(String[] command,
                           String[] env)
                    throws IOException
```
    Запускает процесс
    
    Parameters:
    
    command - Массив (первый элемент - имя файла, последующие параметры)
    
    env - Переменные окружения процесса, где каждая строка является парой имя_перменной=значение
    
    Returns:
    
    Процесс
    
    Throws:
    
    IOException - Ошибка i/o, (файл не существует или нет доступа, др...)
  - exec
```
public static Process exec(String command,
                           String[] env,
                           File dir)
                    throws IOException
```
    Запускает процесс
    
    Parameters:
    
    command - Команда запуска
    
    env - Переменные окружения процесса, где каждая строка является парой имя_перменной=значение
    
    dir - Рабочий каталог процесса
    
    Returns:
    
    Процесс
    
    Throws:
    
    IOException - Ошибка i/o, (файл не существует или нет доступа, др...)
  - exec
```
public static Process exec(String[] command,
                           String[] env,
                           File dir)
                    throws IOException
```
    Запускает процесс
    
    Parameters:
    
    command - Массив (первый элемент - имя файла, последующие параметры)
    
    env - Переменные окружения процесса, где каждая строка является парой имя_перменной=значение
    
    dir - Рабочий каталог процесса
    
    Returns:
    
    Процесс
    
    Throws:
    
    IOException - Ошибка IO
  - addExceptionListenr
```
public static void addExceptionListenr(ExceptionListener listener)
```
    Добаляет слушателя исключений
    
    Parameters:
    
    listener - Слушатель
  - removeExceptionListener
```
public static void removeExceptionListener(ExceptionListener listener)
```
    Удаляет слушателя исключений
    
    Parameters:
    
    listener - Слушатель
  - fireException
```
protected static void fireException(Exception exception)
```
  - getDefaultCharset
```
public static Charset getDefaultCharset()
```
    Возвращает кодировку по умолчанию
    
    Returns:
    
    Кодировка
  - setDefaultCharset
```
public static void setDefaultCharset(Charset defaultCharset)
```
    Устанавливает кодировку по умолчанию
    
    Parameters:
    
    defaultCharset - Кодировка (null - по умолч)
  - getErrorsBufferLength
```
public static Integer getErrorsBufferLength()
```
    Возвращает длину буфера ошибок (символы)
    
    Returns:
    
    Длина stderr буфера
  - setErrorsBufferLength
```
public static void setErrorsBufferLength(Integer errorsBufferLength)
```
    Устанавливает длину буфера ошибок (символы)
    
    Parameters:
    
    errorsBufferLength - Длина stderr буфера (null - по умолч)
  - getErrorsCharset
```
public static Charset getErrorsCharset()
```
    Возвращает кодировку потока ошибок
    
    Returns:
    
    Кодировка
  - setErrorsCharset
```
public static void setErrorsCharset(Charset errorsCharset)
```
    Устанавливает кодировку потока ошибок
    
    Parameters:
    
    errorsCharset - Кодировка (null - по умолч)
  - getInputCharset
```
public static Charset getInputCharset()
```
    Возвращает кодировку входного потока
    
    Returns:
    
    Кодировка
  - setInputCharset
```
public static void setInputCharset(Charset inputCharset)
```
    Устанавливает кодировку входного потока
    
    Parameters:
    
    inputCharset - Кодировка (null - по умолч)
  - getMaxExecuteProcessTime
```
public static Long getMaxExecuteProcessTime()
```
    Возвращает максимальное допустимое время выполнения процесса в миллисекундах
    
    Returns:
    
    Максимальное допустимое время выполнения (0 - бесконечность)
  - setMaxExecuteProcessTime
```
public static void setMaxExecuteProcessTime(Long maxExecuteProcessTime)
```
    Устанавливает максимальное допустимое время выполнения процесса в миллисекундах
    
    Parameters:
    
    maxExecuteProcessTime - Максимальное допустимое время выполнения (0 - бесконечность)
  - getOutputBufferLength
```
public static Integer getOutputBufferLength()
```
    Возвращает длину буфера стандартного потока данных (символы)
    
    Returns:
    
    Длина stdout буфера
  - setOutputBufferLength
```
public static void setOutputBufferLength(Integer outputBufferLength)
```
    Устанавливает длину буфера стандартного потока данных (символы)
    
    Parameters:
    
    outputBufferLength - Длина stdout буфера (null - по умолч)
  - getOutputCharset
```
public static Charset getOutputCharset()
```
    Возвращает кодировку стандартного потока данных
    
    Returns:
    
    Кодировка
  - setOutputCharset
```
public static void setOutputCharset(Charset outputCharset)
```
    Устанавливает кодировку стандартного потока данных
    
    Parameters:
    
    outputCharset - Кодировка (null - по умолч)
  - getRepeatCheckWindow
```
public static Long getRepeatCheckWindow()
```
    Возвращает время через которое проверять завершение процесса
    
    Returns:
    
    время проверки завершения (миллисек.)
  - setRepeatCheckWindow
```
public static void setRepeatCheckWindow(Long repeatCheckWindow)
```
    Устанавливает время через которое проверять завершение процесса
    
    Parameters:
    
    repeatCheckWindow - время проверки завершения (миллисек.)
  - getUnionOutputAndErrors
```
public static Boolean getUnionOutputAndErrors()
```
    Возвращает объединять поток ошибок и стандартный поток (в стандартный)
    
    Returns:
    
    true - объединять; false - нет
  - setUnionOutputAndErrors
```
public static void setUnionOutputAndErrors(Boolean unionOutputAndErrors)
```
    Устанавливает объединять поток ошибок и стандартный поток (в стандартный)
    
    Parameters:
    
    unionOutputAndErrors - true - объединять; false - нет
  - getWaitReadErrorsWindow
```
public static Long getWaitReadErrorsWindow()
```
    Возвращает время через которое проверять наличии данных в потоке stderr (0 - без задержки)
    
    Returns:
    
    время проверки наличии данных (миллисек.)
  - setWaitReadErrorsWindow
```
public static void setWaitReadErrorsWindow(Long waitReadErrorsWindow)
```
    Устанавливает время через которое проверять наличии данных в потоке stderr (0 - без задержки)
    
    Parameters:
    
    waitReadErrorsWindow - время проверки наличии данных (миллисек.)
  - getWaitReadOutputWindow
```
public static Long getWaitReadOutputWindow()
```
    Возвращает время через которое проверять наличии данных в потоке stdout (0 - без задержки)
    
    Returns:
    
    время проверки наличии данных (миллисек.)
  - setWaitReadOutputWindow
```
public static void setWaitReadOutputWindow(Long waitReadOutputWindow)
```
    Устанавливает время через которое проверять наличии данных в потоке stdout (0 - без задержки)
    
    Parameters:
    
    waitReadOutputWindow - время проверки наличии данных (миллисек.)
  - execQuery
```
public static ProcessResult execQuery(String command)
                               throws IOException
```
    Выполняет процесс и возвращает прочитанные данные
    
    Parameters:
    
    command - Процесс и его параметры
    
    Returns:
    
    Результат выполнения
    
    Throws:
    
    IOException - Если файл не найден или запрет безопастности и т.д.
  - execQuery
```
public static ProcessResult execQuery(String command,
                                      String[] env,
                                      File workdir)
                               throws IOException
```
    Выполняет процесс и возвращает прочитанные данные
    
    Parameters:
    
    command - Процесс и его параметры
    
    env - Окружение процесса (+ текущее окружение) (может быть null)
    
    workdir - Рабочий каталог (может быть null)
    
    Returns:
    
    Результат выполнения
    
    Throws:
    
    IOException - Если файл не найден или запрет безопастности и т.д.
  - execQuery
```
public static ProcessResult execQuery(String command,
                                      String[] env,
                                      File workdir,
                                      String procInput)
                               throws IOException
```
    Выполняет процесс и возвращает прочитанные данные
    
    Parameters:
    
    command - Процесс и его параметры
    
    env - Окружение процесса (+ текущее окружение) (может быть null)
    
    workdir - Рабочий каталог (может быть null)
    
    procInput - Входные данные (может быть null)
    
    Returns:
    
    Результат выполнения
    
    Throws:
    
    IOException - Если файл не найден или запрет безопастности и т.д.
  - execQuery
```
public static ProcessResult execQuery(String command,
                                      String[] env,
                                      File workdir,
                                      long maxExecProcMSec,
                                      String procInput)
                               throws IOException
```
    Выполняет процесс (shell) и возвращает прочитанные данные
    
    Parameters:
    
    command - Процесс и его параметры
    
    env - Окружение процесса (+ текущее окружение) (может быть null)
    
    workdir - Рабочий каталог (может быть null)
    
    maxExecProcMSec - Максимальное допустимое время исполнения (0 - бесконечно)
    
    procInput - Входные данные (может быть null)
    
    Returns:
    
    Результат выполнения
    
    Throws:
    
    IOException - Если файл не найден или запрет безопастности и т.д.
  - execQuery
```
public static ProcessResult execQuery(String command,
                                      String[] env,
                                      File workdir,
                                      long maxExecProcMSec,
                                      String procInput,
                                      Charset inStreamCS,
                                      Charset outStreamCS,
                                      int soutBufferLength,
                                      long waitReadSOutMSec,
                                      Charset errorStreamCS,
                                      int serrBufferLength,
                                      long waitReadSErrMSec)
                               throws IOException
```
    Выполняет процесс (shell) и возвращает прочитанные данные
    
    Parameters:
    
    command - Процесс и его параметры
    
    env - Окружение процесса (+ текущее окружение) (может быть null)
    
    workdir - Рабочий каталог (может быть null)
    
    maxExecProcMSec - Максимальное допустимое время исполнения (0 - бесконечно)
    
    procInput - Входные данные (может быть null)
    
    inStreamCS - Кодировка входных данных (может быть null)
    
    outStreamCS - Кодировка стандартного потока вывода (может быть null)
    
    soutBufferLength - Длина буфера стандартного потока данных (символы)
    
    waitReadSOutMSec - Время через которое проверять наличии данных в потоке stdout (0 - без задержки)
    
    errorStreamCS - Кодировка потока ошибок вывода (может быть null)
    
    serrBufferLength - Длина буфера ошибок (символы)
    
    waitReadSErrMSec - Время через которое проверять наличии данных в потоке stderr (0 - без задержки)
    
    Returns:
    
    Результат выполнения
    
    Throws:
    
    IOException - Если файл не найден или запрет безопастности и т.д.
  - runProcessExitListener
```
public static Thread runProcessExitListener(Process proc,
                                            ProcessListener listener,
                                            SyncFlag exitFlag)
```
    Запускает слушаетля процесса в отдельном фоновом потоке, для ожидания завершения процесса.
    Поток завершит прослушивание в случае, если процесс перестанет существовать или будет установлен флаг в значени true
    
    Parameters:
    
    proc - Процесс
    
    listener - Слушатель процесса
    
    exitFlag - Флаг завершения прослушивания
    
    Returns:
    
    Наблюдающий поток/тред
  - runProcessReaderListener
```
public static Thread runProcessReaderListener(Process proc,
                                              ProcessListener listener,
                                              InputStream dataStream,
                                              SyncFlag exitFlag)
```
    Запускает слушаетля процесса в отдельном фоновом потоке, для получения входных данных
    Поток завершит прослушивание в случае, если процесс перестанет существовать или будет установлен флаг в значени true
    
    Parameters:
    
    proc - Процесс
    
    listener - Слушатель процесса
    
    dataStream - Поток данных
    
    exitFlag - Флаг завершения прослушивания
    
    Returns:
    
    Наблюдающий поток/тред
  - runProcessReaderListener
```
public static Thread runProcessReaderListener(Process proc,
                                              ProcessListener listener,
                                              InputStream dataStream,
                                              int bufferSize,
                                              SyncFlag exitFlag)
```
    Запускает слушаетля процесса в отдельном фоновом потоке, для получения входных данных
    Поток завершит прослушивание в случае, если процесс перестанет существовать или будет установлен флаг в значени true
    
    Parameters:
    
    proc - Процесс
    
    listener - Слушатель процесса
    
    dataStream - Поток данных
    
    bufferSize - Размер буфера
    
    exitFlag - Флаг завершения прослушивания
    
    Returns:
    
    Наблюдающий поток/тред

Class ProcUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcUtil

Method Detail

exec

exec

exec

exec

exec

exec

addExceptionListenr

removeExceptionListener

fireException

getDefaultCharset

setDefaultCharset

getErrorsBufferLength

setErrorsBufferLength

getErrorsCharset

setErrorsCharset

getInputCharset

setInputCharset

getMaxExecuteProcessTime

setMaxExecuteProcessTime

getOutputBufferLength

setOutputBufferLength

getOutputCharset

setOutputCharset

getRepeatCheckWindow

setRepeatCheckWindow

getUnionOutputAndErrors

setUnionOutputAndErrors

getWaitReadErrorsWindow

setWaitReadErrorsWindow

getWaitReadOutputWindow

setWaitReadOutputWindow

execQuery

execQuery

execQuery

execQuery

execQuery

runProcessExitListener

runProcessReaderListener

runProcessReaderListener