StreamGobbler (Apache Brooklyn)

java.lang.Object
- java.lang.Thread
- - org.apache.brooklyn.util.stream.StreamGobbler

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Runnable
```
public class StreamGobbler
extends java.lang.Thread
implements java.io.Closeable
```

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary
- Fields inherited from class java.lang.Thread
  MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description
`StreamGobbler(java.io.InputStream stream, java.io.OutputStream out, org.slf4j.Logger log)`
`StreamGobbler(java.io.InputStream stream, java.io.PrintStream out, org.slf4j.Logger log)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`blockUntilFinished()` convenience -- equivalent to calling join()
`void`	`close()`
`boolean`	`isFinished()` convenience -- similar to !Thread.isAlive()
`void`	`onChar(int c)`
`void`	`onClose()`
`void`	`onLine(java.lang.String line)`
`void`	`run()`
`StreamGobbler`	`setLogPrefix(java.lang.String prefix)`
`StreamGobbler`	`setPrefix(java.lang.String prefix)`
`StreamGobbler`	`setPrintPrefix(java.lang.String prefix)`
`void`	`shutdown()` Deprecated.

Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

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

Constructor Detail

StreamGobbler

public StreamGobbler(java.io.InputStream stream,
             java.io.OutputStream out,
             org.slf4j.Logger log)

StreamGobbler

public StreamGobbler(java.io.InputStream stream,
             java.io.PrintStream out,
             org.slf4j.Logger log)

Method Detail

close
```
public void close()
```
Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

shutdown
```
@Deprecated
public void shutdown()
```
Deprecated.

setPrefix

public StreamGobbler setPrefix(java.lang.String prefix)

setPrintPrefix

public StreamGobbler setPrintPrefix(java.lang.String prefix)

setLogPrefix

public StreamGobbler setLogPrefix(java.lang.String prefix)

run
```
public void run()
```
Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

onChar
```
public void onChar(int c)
```

onLine

public void onLine(java.lang.String line)

onClose
```
public void onClose()
```

blockUntilFinished
```
public void blockUntilFinished()
                        throws java.lang.InterruptedException
```
convenience -- equivalent to calling join()

Throws:

java.lang.InterruptedException

isFinished
```
public boolean isFinished()
```
convenience -- similar to !Thread.isAlive()

Class StreamGobbler

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Constructor Detail

StreamGobbler

StreamGobbler

Method Detail

close

shutdown

setPrefix

setPrintPrefix

setLogPrefix

run

onChar

onLine

onClose

blockUntilFinished

isFinished