AbstractProcessReader (processoutput4j 0.1.0 API)

java.lang.Object
- com.github.fracpete.processoutput4j.core.AbstractProcessRunnable
- - com.github.fracpete.processoutput4j.reader.AbstractProcessReader

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

CollectingProcessReader, ConsoleOutputProcessReader, StreamingProcessReader
```
public abstract class AbstractProcessReader
extends AbstractProcessRunnable
```
Ancestor for readers that read line from stdout/stderr of the provided Process object.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields
Modifier and Type Field Description

protected java.io.BufferedReader m_Reader
the reader use internally.

protected boolean m_Stdout
whether to use stdout or stderr.
- Fields inherited from class com.github.fracpete.processoutput4j.core.AbstractProcessRunnable
  m_ErrorLogger, m_PollInterval, m_Process, m_Queue, m_Running, m_Stopped

Constructor Summary

Constructors
Constructor	Description
`AbstractProcessReader(boolean stdout)`	Initializes the reader.
`AbstractProcessReader(int pollInterval, ErrorLogger errorLogger, boolean stdout)`	Initializes the reader.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doRun()`	The actual processing loop.
`void`	`flush()`	Flushes the data.
`boolean`	`isStdout()`	Returns whether the reader is for stdout or stderr.
`protected abstract void`	`process(java.lang.String line)`	For processing the line read from stdout/stderr.

Methods inherited from class com.github.fracpete.processoutput4j.core.AbstractProcessRunnable
getProcess, isRunning, isStopped, logError, logError, run, setProcess, stopExecution

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

- Field Detail
  - m_Stdout
```
protected boolean m_Stdout
```
    whether to use stdout or stderr.
  - m_Reader
```
protected java.io.BufferedReader m_Reader
```
    the reader use internally.
- Constructor Detail
  - AbstractProcessReader
```
public AbstractProcessReader(boolean stdout)
```
    Initializes the reader.
    
    Parameters:
    
    stdout - whether to read stdout or stderr
  - AbstractProcessReader
```
public AbstractProcessReader(int pollInterval,
                             ErrorLogger errorLogger,
                             boolean stdout)
```
    Initializes the reader.
    
    Parameters:
    
    pollInterval - the timeout interval in milliseconds to use when polling for new output
    
    errorLogger - the error logger to use
    
    stdout - whether to read stdout or stderr
- Method Detail
  - isStdout
```
public boolean isStdout()
```
    Returns whether the reader is for stdout or stderr.
    
    Returns:
    
    true if for stdout
  - process
```
protected abstract void process(java.lang.String line)
```
    For processing the line read from stdout/stderr.
    
    Parameters:
    
    line - the output line
  - flush
```
public void flush()
```
    Flushes the data.
  - doRun
```
protected void doRun()
```
    The actual processing loop.
    
    Specified by:
    
    doRun in class AbstractProcessRunnable