qflib 0.98.1

de.qfs.lib.log
Interface LogUser

All Superinterfaces:
LogFilter
All Known Implementing Classes:
StreamFilter, AbstractLogUser, RemoteLogFilter

public interface LogUser
extends LogFilter

The LogUser interface extends LogFilter for customization.

There are two kinds of uses for a LogFilter. One use is to filter out unneeded messages to avoid cluttering of whatever means are used to display the logs.

The other use is to divert the LogEntries to a place other than System.err, like a log file or a remote log server. Multiple filters of this kind may be used together, e.g. remote logging may be combined with saving logs to a log file, so it must be possible to configure the filters whether they should pass on log entries they have used to the next filter.

Version:
$Revision: 1.4 $
Author:
Gregor Schmid

Field Summary
static int FILTER_ALL
          Tells the LogUser to block all log entries.
static int FILTER_NONE
          Tells the LogUser to let everything pass.
static int FILTER_UNUSED
          Tells the LogUser to let only logs used by it pass.
static int FILTER_USED
          Tells the LogUser to filer out logs used by it.
 
Method Summary
 void setFilterMode(int mode)
          Configure the LogUser's filter mode.
 
Methods inherited from interface de.qfs.lib.log.LogFilter
filter, filter
 

Field Detail

FILTER_USED

public static final int FILTER_USED
Tells the LogUser to filer out logs used by it.

FILTER_UNUSED

public static final int FILTER_UNUSED
Tells the LogUser to let only logs used by it pass.

FILTER_ALL

public static final int FILTER_ALL
Tells the LogUser to block all log entries.

FILTER_NONE

public static final int FILTER_NONE
Tells the LogUser to let everything pass.
Method Detail

setFilterMode

public void setFilterMode(int mode)
Configure the LogUser's filter mode.
Parameters:
mode - The mode to set. Possible values are:
FILTER_USED
Tells the LogUser to filer out logs used by it.
FILTER_UNUSED
Tells the LogUser to let only logs used by it pass.
FILTER_ALL
Tells the LogUser to block all log entries.
FILTER_NONE
Tells the LogUser to let everything pass.

qflib 0.98.1