| java.lang.Object
 java.util.logging.Formatter
org.geotools.util.MonolineFormatter
| MonolineFormatter | | public class MonolineFormatter extends Formatter (Code) | | A formatter writting log messages on a single line. This formatter is used by
Geotools 2 instead of
SimpleFormatter . The main difference is that
this formatter use only one line per message instead of two. For example, a
message formatted by
MonolineFormatter looks like:
FINE core - A log message logged with level FINE from the "org.geotools.core" logger.
By default,
MonolineFormatter display only the level and the
message. Additional fields can be formatted if
MonolineFormatter.setTimeFormat or
MonolineFormatter.setSourceFormat methods are invoked with a non-null argument. The
format can also be set from the
jre/lib/logging.properties file. For example, user can cut and paste the following properties into
logging.properties :
############################################################
# Properties for the Geotools's MonolineFormatter.
# By default, the monoline formatter display only the level
# and the message. Additional fields can be specified here:
#
# time: If set, writes the time ellapsed since the initialization.
# The argument specifies the output pattern. For example, the
# pattern HH:mm:ss.SSSS display the hours, minutes, seconds
# and milliseconds.
#
# source: If set, writes the source logger or the source class name.
# The argument specifies the type of source to display. Valid
# values are none, logger:short, logger:long, class:short and
# class:long.
############################################################
org.geotools.util.MonolineFormatter.time = HH:mm:ss.SSS
org.geotools.util.MonolineFormatter.source = class:short
If the
MonolineFormatter is wanted for the whole system
(not just the
org.geotools packages) with level FINE (for
example), then the following properties can be defined as below:
java.util.logging.ConsoleHandler.formatter = org.geotools.util.MonolineFormatter
java.util.logging.ConsoleHandler.encoding = Cp850
java.util.logging.ConsoleHandler.level = FINE
since:
2.0
version:
$Id: MonolineFormatter.java 27848 2007-11-12 13:10:32Z desruisseaux $
author:
Martin Desruisseauxorg.geotools.util.logging |
| Method Summary | |
| public synchronized String | format(LogRecord record)
Format the given log record and return the formatted string.
Parameters:
record - the log record to be formatted. | | public String | getSourceFormat()
Returns the format for displaying the source. | | public synchronized String | getTimeFormat()
Returns the format for displaying ellapsed time. | | public static MonolineFormatter | init(String base)
Setup a
MonolineFormatter for the specified logger and its
children. | | public static MonolineFormatter | init(String base, Level level)
Setup a
MonolineFormatter for the specified logger and its children. | | public static void | initGeotools()
Initialise the formatter for the "
org.geotools " loggers. | | public static void | initGeotools(Level level)
Initialise the formatter for the "
org.geotools " loggers with the specified
level. | | public synchronized void | setSourceFormat(String format)
Set the format for displaying the source. | | public synchronized void | setTimeFormat(String pattern)
Set the format for displaying ellapsed time. |
| MonolineFormatter | | public MonolineFormatter()(Code) | | Construct a default
MonolineFormatter .
|
| MonolineFormatter | | public MonolineFormatter(String base)(Code) | | Construct a
MonolineFormatter .
Parameters:
base - The base logger name. This is used for shortening the logger name when formatting message. For example, if the base logger name is "org.geotools" and a log record come from the "org.geotools.core" logger, it will be formatted as "[LEVEL core]" (i.e. the "org.geotools" part is ommited). |
| format | | public synchronized String format(LogRecord record)(Code) | | Format the given log record and return the formatted string.
Parameters:
record - the log record to be formatted. a formatted log record |
| getSourceFormat | | public String getSourceFormat()(Code) | | Returns the format for displaying the source. This is the pattern specified
to the last call to
MonolineFormatter.setSourceFormat , or the patten specified in the
org.geotools.MonolineFormater.source property in the
jre/lib/logging.properties file.
The source pattern, or null if source is not formatted. |
| getTimeFormat | | public synchronized String getTimeFormat()(Code) | | Returns the format for displaying ellapsed time. This is the pattern specified
to the last call to
MonolineFormatter.setTimeFormat , or the patten specified in the
org.geotools.MonolineFormater.time property in the
jre/lib/logging.properties file.
The time pattern, or null if time is not formatted. |
| init | | public static MonolineFormatter init(String base, Level level)(Code) | | Setup a
MonolineFormatter for the specified logger and its children. This method
search for all instances of
ConsoleHandler using the
SimpleFormatter . If
such instances are found, they are replaced by a single instance of
MonolineFormatter writting to the
(instead of the
). If no such
ConsoleHandler are found, then a new
one is created with this
MonolineFormatter . This action has no effect on any loggers
outside the
base namespace.
In addition, this method can set the logger levels. If the level is non-null, then all
Handler s using the monoline formatter will be set to the specified level. The
logger named
base will also be set to this level.
Note: Avoid non-null
level argument as much as possible, since it overrides
user's level setting for the
base logger. A user trying to configure his logging
properties may find confusing to see his setting ignored.
Parameters:
base - The base logger name to apply the change on (e.g. "org.geotools").
Parameters:
level - The desired level, or null if no level should be set. The registered MonolineFormatter (never null ).The formatter output can be configured using the MonolineFormatter.setTimeFormatand MonolineFormatter.setSourceFormat methods. |
| initGeotools | | public static void initGeotools(Level level)(Code) | | Initialise the formatter for the "
org.geotools " loggers with the specified
level. NOTE: Avoid this method as much as possible, since it overrides
user's level setting for the "
org.geotools " logger. A user trying to
configure its logging properties may find confusing to see his setting ignored.
Parameters:
level - The logging level, or null if no level should be set.Logging.forceMonolineConsoleOutput(Level)MonolineFormatter.init(String,Level) |
| setSourceFormat | | public synchronized void setSourceFormat(String format)(Code) | | Set the format for displaying the source. The pattern may be one of the following:
"none",
"logger:short", "class:short",
"logger:long" or "class:long".
The difference between a
null and "none" is that
null may be replaced by a default value, while "none" means that the user
explicitly requested no source.
Parameters:
format - The format for displaying the source. |
| setTimeFormat | | public synchronized void setTimeFormat(String pattern)(Code) | | Set the format for displaying ellapsed time. The pattern must matches
the format specified in
SimpleDateFormat . For example, the
pattern "HH:mm:ss.SSS" will display the ellapsed time
in hours, minutes, seconds and milliseconds.
Parameters:
pattern - The time patter, or null to disable time formatting. |
|
|