Module org.autogui

Package org.autogui.swing.log

Class GuiSwingLogManager

java.lang.Object

org.autogui.base.log.GuiLogManager

org.autogui.swing.log.GuiSwingLogManager

public class GuiSwingLogManager
extends GuiLogManager

a log-manager supporting Swing GUI

     GuiSwingLogManager m = new GuiSwingLogManager();
     m.setupConsole(
               GuiSwingLogManager.replaceErr,
               GuiSwingLogManager.replaceOut,
               GuiSwingLogManager.replaceExceptionHandler,
               GuiSwingLogManager.redirectToConsole,
               GuiSwingLogManager.suppressOutputRedirection);
     GuiLogManager.setManager(m);
     ...
     frame.setContentPane(m.createWindow().getPaneWithStatusBar(frame.getContentPane()));
     ...
     GuiLogManager.log(...);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiSwingLogManager.GuiSwingLogRenderer	a log-entry renderer for a list and a status-bar
static interface	GuiSwingLogManager.GuiSwingLogView	methods of the interface might happen outside of the event thread
static class	GuiSwingLogManager.GuiSwingLogWindow	a window for displaying log-list
static class	GuiSwingLogManager.LogWindowShowAction	an action for showing the log-list, displayed on a status-bar

Nested classes/interfaces inherited from class org.autogui.base.log.GuiLogManager

GuiLogManager.LogOutputStream, GuiLogManager.LogPrintStream, GuiLogManager.LogStreamType, GuiLogManager.LogUncaughtHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected GuiLogManagerConsole	console
static boolean	redirectToConsole
static boolean	replaceErr
static boolean	replaceExceptionHandler
static boolean	replaceOut
static boolean	suppressOutputRedirection
protected List<GuiSwingLogManager.GuiSwingLogView>	views

Fields inherited from class org.autogui.base.log.GuiLogManager

manager

Constructor Summary

Constructors

Constructor	Description
GuiSwingLogManager()

Method Summary

Modifier and Type	Method	Description
Object	addView(Consumer<GuiLogEntry> view)
Object	addView(GuiSwingLogManager.GuiSwingLogView view)
void	clear()	call GuiSwingLogManager.GuiSwingLogView.clearLogEntries() to views
GuiSwingLogManager.GuiSwingLogWindow	createWindow()
GuiLogManagerConsole	getConsole()
PrintStream	getErr()
static Font	getFont()
static GuiSwingLogManager	getOrSetSwingLogManager()
GuiLogEntryException	logError(Throwable ex)	create an exception entry and show it
GuiLogEntryProgress	logProgress()	create an active progress entry and show it.
GuiLogEntryString	logString(String str, boolean fromStandard)	create a string entry and show it.
void	removeView(Object v)
void	setConsole(GuiLogManagerConsole console)
static void	setDefaultReplace(boolean flag)
static void	setRedirectToConsole(boolean flag)
static void	setSuppressOutputRedirection(boolean flag)
GuiLogManager	setupConsole(boolean replaceError, boolean replaceOutput, boolean uncaughtHandler, boolean redirectToConsole)
GuiLogManager	setupConsole(boolean replaceError, boolean replaceOutput, boolean uncaughtHandler, boolean redirectToConsole, boolean suppressOutputRedirection)	controls logging redirection.
GuiLogManager	setupConsoleWithDefaultFlags()	the method calls setupConsole(boolean, boolean, boolean, boolean, boolean) with reading following properties with conjunction of static fields.
void	show(GuiLogEntry e)	update display of the entry.
void	updateProgress(GuiLogEntryProgress p)

Methods inherited from class org.autogui.base.log.GuiLogManager

formatDuration, formatMessageLine, formatTime, get, getSystemErr, isSymbol, log, logFormat, logProgress, logString, replaceConsole, replaceUncaughtHandler, resetErr, resetOut, resetUncaughtHandler, setManager

Methods inherited from class java.lang.Object

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

Field Details

views

protected List<GuiSwingLogManager.GuiSwingLogView> views

console

protected GuiLogManagerConsole console

replaceErr

public static boolean replaceErr

replaceOut

public static boolean replaceOut

replaceExceptionHandler

public static boolean replaceExceptionHandler

redirectToConsole

public static boolean redirectToConsole

suppressOutputRedirection

public static boolean suppressOutputRedirection

Since:

1.1

Constructor Details

GuiSwingLogManager

public GuiSwingLogManager()

Method Details

setDefaultReplace

public static void setDefaultReplace(boolean flag)

setRedirectToConsole

public static void setRedirectToConsole(boolean flag)

setSuppressOutputRedirection

public static void setSuppressOutputRedirection(boolean flag)

Parameters:

flag - flag for suppressOutputRedirection

Since:

1.1

addView

public Object addView(Consumer<GuiLogEntry> view)

Parameters:

view - might accept same entries

Returns:

key object for removing, currently view itself

addView

public Object addView(GuiSwingLogManager.GuiSwingLogView view)

Parameters:

view - a view for log entries, might accept same entries

Returns:

key object for removing, currently view itself

Since:

1.2

removeView

public void removeView(Object v)

setConsole

public void setConsole(GuiLogManagerConsole console)

getConsole

public GuiLogManagerConsole getConsole()

getOrSetSwingLogManager

public static GuiSwingLogManager getOrSetSwingLogManager()

Returns:

existing manager from GuiLogManager.get() or a new manager

Since:

1.1

setupConsoleWithDefaultFlags

public GuiLogManager setupConsoleWithDefaultFlags()

the method calls setupConsole(boolean, boolean, boolean, boolean, boolean) with reading following properties with conjunction of static fields. those properties take "true" (default) or "false".

• autogui.log.replaceErr
• autogui.log.replaceOut
• autogui.log.replaceExceptionHandler
• autogui.log.redirectToConsole
• autogui.log.suppressOutputRedirection

Returns:

this

Since:

1.1

See Also:

• setupConsole(boolean, boolean, boolean, boolean, boolean)

setupConsole

public GuiLogManager setupConsole(boolean replaceError,
 boolean replaceOutput,
 boolean uncaughtHandler,
 boolean redirectToConsole)

setupConsole

public GuiLogManager setupConsole(boolean replaceError,
 boolean replaceOutput,
 boolean uncaughtHandler,
 boolean redirectToConsole,
 boolean suppressOutputRedirection)

controls logging redirection.

     setupConsole(true, true, true, true, true);
     //default: redirect to console and GUI-list
      System.err.print("msg"); // => stderr: "[Time...] msg",  GUI-list: "[Time...] msg"
      System.out.print("msg"); // => stdout: "msg",            GUI-list: "[Time...] msg"
      logString("msg");        // => stderr: "[Time...] msg",  GUI-list: "[Time...] msg"

     setupConsole(false, false, true, true, true);
     //no stdout/stderr replacement.
      System.err.print("msg"); // => stderr: "msg"
      System.out.print("msg"); // => stdout: "msg"
      logString("msg");        // => stderr: "[Time...] msg",  GUI-list: "[Time...] msg"

     setupConsole(true, true, true, false, true);
     //no console redirection: only stdout directly write message to the console as outputs
      System.err.print("msg"); // =>                           GUI-list: "[Time...] msg"
      System.out.print("msg"); // => stdout: "msg",            GUI-list: "[Time...] msg"
      logString("msg");        // =>                           GUI-list: "[Time...] msg"

     setupConsole(false, false, true, false, true);
     //no stdout/stderr replacement, and no console redirection: stdout/stderr just work as original
      System.err.print("msg"); // =>  stderr: "msg"
      System.out.print("msg"); // =>  stdout: "msg"
      logString("msg");        // =>                           GUI-list: "[Time...] msg"

     setupConsole(true, true, true, true, false);
     //full redirection: stdout also writes to stderr
      System.err.print("msg"); // =>  stderr: "[Time...] msg",                GUI-list: "[Time...] msg"
      System.out.print("msg"); // =>  stderr: "[Time...] msg", stdout: "msg", GUI-list: "[Time...] msg"
      logString("msg");        // =>  stderr: "[Time...] msg",                GUI-list: "[Time...] msg"

 

Parameters:

replaceError - replace System.err for redirection to the GUI list

replaceOutput - replace System.out for redirection to the GUI list

uncaughtHandler - replace the uncaught-handler for redirection to the GUI list

redirectToConsole - adding GuiLogManagerConsole to the manager: this means that the GUI list redirects to the console (original System.err)

suppressOutputRedirection - avoiding redirection of redirectToConsole from replaced System.out. So work only if replaceOutput=true and redirectToConsole=true

Returns:

this

Since:

1.1

getErr

public PrintStream getErr()

Overrides:

getErr in class GuiLogManager

logString

public GuiLogEntryString logString(String str,
 boolean fromStandard)

Description copied from class: GuiLogManager

create a string entry and show it.

Overrides:

logString in class GuiLogManager

Parameters:

str - the string for the entry

fromStandard - whether the string come from the standard output (or error) redirection

Returns:

the created log entry

logError

public GuiLogEntryException logError(Throwable ex)

Description copied from class: GuiLogManager

create an exception entry and show it

Overrides:

logError in class GuiLogManager

Parameters:

ex - the exception

Returns:

the created entry

logProgress

public GuiLogEntryProgress logProgress()

Description copied from class: GuiLogManager

create an active progress entry and show it. the returned progress is determinate (isIndeterminate() == false), and notifies progress changes to the manager by GuiLogManager.updateProgress(GuiLogEntryProgress)

     try (GuiLogEntryProgress p = manager.logProgress();) {
         for (...) {
             //those methods will cause a runtime-exception if the thread is interrupted.
             p.addValueP(0.01f)
               .setMessage("running ...");
             ...
             //the running code can checks interruption
             if (Thread.interrupted()) {
                 break;
             }
             ...
         }
     } catch (Exception ex) { ... }
 

Overrides:

logProgress in class GuiLogManager

Returns:

the created progress entry

updateProgress

public void updateProgress(GuiLogEntryProgress p)

Overrides:

updateProgress in class GuiLogManager

show

public void show(GuiLogEntry e)

Description copied from class: GuiLogManager

update display of the entry.

Overrides:

show in class GuiLogManager

Parameters:

e - the displayed entry

clear

public void clear()

call GuiSwingLogManager.GuiSwingLogView.clearLogEntries() to views

Since:

1.2

getFont

public static Font getFont()

createWindow

public GuiSwingLogManager.GuiSwingLogWindow createWindow()