LogOutputStream (nf-commons 20.04.1 API)

nextflow.io.LogOutputStream

Base class to connect a logging system to the output and/or error stream of then external process. The implementation parses the incoming data to construct a line and passes the complete line to an user-defined implementation.
Version:
\$Id: LogOutputStream.java 1636056 2014-11-01 21:12:52Z ggregory \$

Constructor Summary

Constructors
Constructor and description
`LogOutputStream ()` Creates a new instance of this class.
`LogOutputStream (int level)` Creates a new instance of this class.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`close()` Writes all remaining data from the buffer.
	`void`	`flush()` Flush this log stream.
	`int`	`getMessageLevel()` @return the trace level of the log system
	`protected void`	`processBuffer()` Converts the buffer to a string and sends it to `processLine`.
	`protected void`	`processLine(java.lang.String line)` Logs a line to the log system of the user.
	`protected void`	`processLine(java.lang.String line, int logLevel)` Logs a line to the log system of the user.
	`void`	`write(int cc)` Write the data to the buffer and flush the buffer, if a line separator is detected.
	`void`	`write(byte[] b, int off, int len)` Write a block of characters to the output stream

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.io.OutputStream`	`java.io.OutputStream#write([B, int, int), java.io.OutputStream#write([B), java.io.OutputStream#write(int), java.io.OutputStream#flush(), java.io.OutputStream#close(), java.io.OutputStream#wait(long, int), java.io.OutputStream#wait(long), java.io.OutputStream#wait(), java.io.OutputStream#equals(java.lang.Object), java.io.OutputStream#toString(), java.io.OutputStream#hashCode(), java.io.OutputStream#getClass(), java.io.OutputStream#notify(), java.io.OutputStream#notifyAll()`

- Constructor Detail
  - public LogOutputStream()
    
    Creates a new instance of this class. Uses the default level of 999.
  - public LogOutputStream(int level)
    
    Creates a new instance of this class.
    Parameters:
    level - loglevel used to log data written to this stream.
- Method Detail
  - @java.lang.Override public void close()
    
    Writes all remaining data from the buffer.
    See Also:
    java.io.OutputStream#close()
  - @java.lang.Override public void flush()
    
    Flush this log stream.
    See Also:
    java.io.OutputStream#flush()
  - public int getMessageLevel()
    
    Returns:
    the trace level of the log system
  - protected void processBuffer()
    
    Converts the buffer to a string and sends it to processLine.
  - protected void processLine(java.lang.String line)
    
    Logs a line to the log system of the user.
    Parameters:
    line - the line to log.
  - protected void processLine(java.lang.String line, int logLevel)
    
    Logs a line to the log system of the user.
    Parameters:
    line - the line to log.
    logLevel - the log level to use
  - @java.lang.Override public void write(int cc)
    
    Write the data to the buffer and flush the buffer, if a line separator is detected.
    Parameters:
    cc - data to log (byte).
    See Also:
    java.io.OutputStream#write(int)
  - @java.lang.Override public void write(byte[] b, int off, int len)
    
    Write a block of characters to the output stream
    throws:
    java.io.IOException if the data cannot be written into the stream.
    
    Parameters:
    b - the array containing the data
    off - the offset into the array where data starts
    len - the length of block
    See Also:
    java.io.OutputStream#write(byte[], int, int)

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Java] Class LogOutputStream

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public LogOutputStream()

public LogOutputStream(int level)

Method Detail

@java.lang.Override public void close()

@java.lang.Override public void flush()

public int getMessageLevel()

protected void processBuffer()

protected void processLine(java.lang.String line)

protected void processLine(java.lang.String line, int logLevel)

@java.lang.Override public void write(int cc)

@java.lang.Override public void write(byte[] b, int off, int len)