com.tplan.robot.util

Class ErrorLog

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

com.tplan.robot.util.ErrorLog

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, Runnable

public class ErrorLog
extends PrintStream
implements Runnable

Dual file and console log stream used in place of System.err and System.out to print out errors both to the console (terminal) as well as to a log file in the OS specific temporary directory.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFG_LOG_DIR

Method Summary

Modifier and Type	Method and Description
static void	addErrListener(PropertyChangeListener l) Add a listener to the System.err stream.
static void	addOutListener(PropertyChangeListener l) Add a listener to the System.out stream.
static void	close(boolean deleteLogFile, boolean printHeader)
static void	dumpNow() Dump all thread stack traces to the error output.
static File	getCurrentLogFile()
static File	getDefaultLogDir()
static File	getLogDirectory()
static LinkedHashMap<Long,File>	getLogFiles()
static PrintStream	install()
boolean	isEnabled() Find out if the log is enabled.
static boolean	isOS64Bit()
static void	relocate(String path)
static void	removeErrListener(PropertyChangeListener l) Remove a listener from the System.err stream.
static void	removeOutListener(PropertyChangeListener l) Remove a listener from the System.out stream.
void	run()
static void	scheduleDump(int time, boolean repeats) Schedule an application dump to write all thread stack traces into the console and the log file.
static void	scheduleDump(int time, boolean repeats, File heapDumpFile) Schedule an application dump to write all thread stack traces into the console and the log file and optionally also a heap dump.
static void	setDiscardLog(boolean aDiscardLog) Set the flag indicating whether the log should be discarded and its file deleted on exit.
void	setEnabled(boolean enabled) Enable or disable the log.
static void	shutDown() Shut down the logger and close the log file.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.PrintStream

append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println

Methods inherited from class java.lang.Object

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

Field Detail

CFG_LOG_DIR

public static final String CFG_LOG_DIR

See Also:

Constant Field Values

Method Detail

relocate

public static void relocate(String path)
                     throws IOException

Throws:

IOException

getDefaultLogDir

public static File getDefaultLogDir()

write

public void write(int b)

Overrides:

write in class PrintStream

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)

Overrides:

write in class PrintStream

run

public void run()

Specified by:

run in interface Runnable

shutDown

public static void shutDown()

Shut down the logger and close the log file.

install

public static PrintStream install()
                           throws IOException

Throws:

IOException

close

public static void close(boolean deleteLogFile,
                         boolean printHeader)

addOutListener

public static void addOutListener(PropertyChangeListener l)

Add a listener to the System.out stream.

Parameters:

l - a listener to be notified when a string gets printed out through System.out.

removeOutListener

public static void removeOutListener(PropertyChangeListener l)

Remove a listener from the System.out stream.

Parameters:

l - a listener.

addErrListener

public static void addErrListener(PropertyChangeListener l)

Add a listener to the System.err stream.

Parameters:

l - a listener to be notified when a string gets printed out through System.err.

removeErrListener

public static void removeErrListener(PropertyChangeListener l)

Remove a listener from the System.err stream.

Parameters:

l - a listener.

isOS64Bit

public static boolean isOS64Bit()

getLogDirectory

public static File getLogDirectory()

getCurrentLogFile

public static File getCurrentLogFile()

getLogFiles

public static LinkedHashMap<Long,File> getLogFiles()

isEnabled

public boolean isEnabled()

Find out if the log is enabled.

Returns:

true if enabled or false otherwise.

Since:

4.1

setEnabled

public void setEnabled(boolean enabled)

Enable or disable the log. A disabled log will discard all inputs.

Parameters:

enabled - true to enable or false to disable. The log is by default enabled.

Since:

4.1

scheduleDump

public static void scheduleDump(int time,
                                boolean repeats)

Schedule an application dump to write all thread stack traces into the console and the log file.

Parameters:

time - time period.

repeats - true to repeat the dump, false for one time dump.

scheduleDump

public static void scheduleDump(int time,
                                boolean repeats,
                                File heapDumpFile)

Schedule an application dump to write all thread stack traces into the console and the log file and optionally also a heap dump.

Parameters:

time - time period.

repeats - true to repeat the dump, false for one time dump.

heapDumpFile - the file to write the heap dump to. When null no heap dump will be created.

Since:

4.1

dumpNow

public static void dumpNow()

Dump all thread stack traces to the error output.

Since:

3.4

setDiscardLog

public static void setDiscardLog(boolean aDiscardLog)

Set the flag indicating whether the log should be discarded and its file deleted on exit.

Parameters:

aDiscardLog - true to make the logger discard the log.

Since:

6.3.1