Package org.frankframework.larva.output

Class LarvaWriter

java.lang.Object

org.frankframework.larva.output.LarvaWriter

Direct Known Subclasses:

LarvaHtmlWriter

public class LarvaWriter
extends Object

Output specific for Larva. Wraps around an OutputStream, or a Writer.

Output can be regular output messages, or log-output that should be shown to the user. Both are written to the same output stream, but each can be temporarily written to a buffer instead of the output stream in order not to mix up log messages with regular messages when that would not be appropriate. (This feature is copied from the old Larva code).

Most classes in Larva will need the LarvaWriter in order to write log messages that are used in user-feedback. Some classes will need access to the LarvaWriter to write regular messages -- mostly these will be implementations of TestExecutionObserver that will write user-output about the status of test execution.

The LarvaWriter can always be access from the LarvaTool instance if required.

Constructor Summary

Constructors

Constructor	Description
LarvaWriter(LarvaConfig larvaConfig, OutputStream out)
LarvaWriter(LarvaConfig larvaConfig, Writer writer)

Method Summary

Modifier and Type	Method	Description
void	debugMessage(String message)
protected void	doWriteMessage(LarvaLogLevel logLevel, boolean isLogMessage, String message)
void	errorMessage(String message)
void	errorMessage(String message, Throwable t)
void	flush()
protected Writer	getTargetWriter(boolean isLogMessage)
void	infoMessage(String message)
void	setBufferLogMessages(boolean bufferLogMessages)
void	setBufferOutputMessages(boolean bufferOutputMessages)
boolean	shouldWriteLevel(LarvaLogLevel logLevel)
void	warningMessage(String message)
void	writeLogMessage(LarvaLogLevel logLevel, String message)
void	writeOutputMessage(LarvaLogLevel logLevel, String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LarvaWriter

public LarvaWriter(LarvaConfig larvaConfig,
 Writer writer)

LarvaWriter

public LarvaWriter(LarvaConfig larvaConfig,
 OutputStream out)

Method Details

flush

public void flush()

setBufferLogMessages

public void setBufferLogMessages(boolean bufferLogMessages)

setBufferOutputMessages

public void setBufferOutputMessages(boolean bufferOutputMessages)

getTargetWriter

protected Writer getTargetWriter(boolean isLogMessage)

doWriteMessage

protected void doWriteMessage(LarvaLogLevel logLevel,
 boolean isLogMessage,
 String message)

shouldWriteLevel

public boolean shouldWriteLevel(LarvaLogLevel logLevel)

writeOutputMessage

public void writeOutputMessage(LarvaLogLevel logLevel,
 String message)

writeLogMessage

public void writeLogMessage(LarvaLogLevel logLevel,
 String message)

debugMessage

public void debugMessage(String message)

infoMessage

public void infoMessage(String message)

errorMessage

public void errorMessage(String message)

warningMessage

public void warningMessage(String message)

errorMessage

public void errorMessage(String message,
 Throwable t)