Return-Path: X-Original-To: apmail-incubator-ooo-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-ooo-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 86204777F for ; Sun, 27 Nov 2011 23:07:04 +0000 (UTC) Received: (qmail 88047 invoked by uid 500); 27 Nov 2011 23:07:04 -0000 Delivered-To: apmail-incubator-ooo-commits-archive@incubator.apache.org Received: (qmail 88001 invoked by uid 500); 27 Nov 2011 23:07:04 -0000 Mailing-List: contact ooo-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: ooo-dev@incubator.apache.org Delivered-To: mailing list ooo-commits@incubator.apache.org Received: (qmail 87994 invoked by uid 99); 27 Nov 2011 23:07:04 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 27 Nov 2011 23:07:04 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 27 Nov 2011 23:06:59 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id EC61E2388C06; Sun, 27 Nov 2011 23:05:51 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1206901 [18/20] - in /incubator/ooo/ooo-site/trunk/content/udk/java: ./ documentation/ documentation/com/ documentation/com/sun/ documentation/com/sun/star/ documentation/com/sun/star/comp/ documentation/com/sun/star/comp/bridgefactory/ do... Date: Sun, 27 Nov 2011 23:05:38 -0000 To: ooo-commits@incubator.apache.org From: kschenk@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20111127230551.EC61E2388C06@eris.apache.org> Added: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Logger.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Logger.html?rev=1206901&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Logger.html (added) +++ incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Logger.html Sun Nov 27 23:04:57 2011 @@ -0,0 +1,657 @@ + + + + + + +: Class Logger + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +com.sun.star.util.logging +
+Class Logger

+
+java.lang.Object
+  |
+  +--com.sun.star.util.logging.Logger
+
+
+
+
public class Logger
extends java.lang.Object
implements ILogger
+ +

+A Logger object is used to log messages for a specific + system or application component. Loggers are normally named, + using a hierarchical dot-separated namespace. Logger names + can be arbitrary strings, but they should normally be based on + the package name or class name of the logged component, such + as java.net or javax.swing. +

+ Logger objects are obtained by a call to the getLogger + factory method. This will either create a new Logger or + return a suitable existing Logger. +

+ Logging messages will be forwarded to registered Handler + objects, which can forward the messages to a variety of + destinations, including consoles, files, OS logs, etc. +

+ On each logging call the Logger initially performs a cheap + check of the request level (e.g. SEVERE or FINE) against a + log level maintained by the logger. If the request level is + lower than the log level, the logging call returns immediately. +

+ The log level is is read from the properties in the + logging configuration file, as described in the description + of the LogManager class. +

+ Formatting is the responsibility of + the output Handler, which will typically call a Formatter/Layout. +

+ Note that formatting need not occur synchronously. It may be delayed + until a LogRecord is actually written to an external sink. +

+ All methods on Logger are multi-thread safe. +

+

+ +

+ + + + + + + + + + + +
+Inner Class Summary
+ classLogger.LoggerPropertyChangeListener + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  Logger.LoggerPropertyChangeListenerm_aListener + +
+           
+protected static java.util.Hashtablem_aLoggerHash + +
+           
+protected  ILoggerm_aWrapper + +
+           
+protected  java.lang.Stringm_sName + +
+           
+  + + + + + + + + + + + +
+Constructor Summary
+protected Logger(ILogger aLogger) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconfig(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+          Log a CONFIG message, specifying source class and method. +
+protected static ILoggercreateWrapper(java.lang.String sName) + +
+           
+ voidfine(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+          Log a FINE message, specifying source class and method. +
+ voidfiner(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+          Log a FINER message, specifying source class and method. +
+ voidfinest(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+          Log a FINEST message, specifying source class and method. +
+ ILoggergetConfiguredInstance() + +
+           
+static LoggergetLogger(java.lang.String sName) + +
+          Find or create a logger for a named subsystem.
+ voidinfo(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+          Log an INFO message, specifying source class and method. +
+ booleanisLoggable(Level level) + +
+          Check if a message of the given level would actually be logged + by this logger.
+protected static ILoggerloadClassLogger(java.lang.String sName, + java.lang.String sClass) + +
+           
+protected  voidreconfigure() + +
+           
+ voidsevere(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+          Log a SEVERE message, specifying source class and method. +
+ voidwarning(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+          Log a WARNING message, specifying source class and method. +
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+m_aLoggerHash

+
+protected static java.util.Hashtable m_aLoggerHash
+
+
+
+ +

+m_aWrapper

+
+protected ILogger m_aWrapper
+
+
+
+ +

+m_sName

+
+protected java.lang.String m_sName
+
+
+
+ +

+m_aListener

+
+protected Logger.LoggerPropertyChangeListener m_aListener
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Logger

+
+protected Logger(ILogger aLogger)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getLogger

+
+public static Logger getLogger(java.lang.String sName)
+
+
Find or create a logger for a named subsystem. If a logger has + already been created with the given name it is returned. Otherwise + a new logger is created. +

+ If a new logger is created its log level will be configured + based on the LogManager configuration and it will configured + to send logging output to all global output Handlers.

+
Parameters:
name - A name for the logger. This should + be a dot-separated name and should normally + be based on the package name or class name + of the subsystem, such as java.net + or javax.swing
Returns:
a suitable Logger
+
+
+
+ +

+createWrapper

+
+protected static ILogger createWrapper(java.lang.String sName)
+
+
+
+
+
+
+ +

+loadClassLogger

+
+protected static ILogger loadClassLogger(java.lang.String sName,
+                                         java.lang.String sClass)
+
+
+
+
+
+
+ +

+reconfigure

+
+protected void reconfigure()
+
+
+
+
+
+
+ +

+getConfiguredInstance

+
+public ILogger getConfiguredInstance()
+
+
+
Specified by:
getConfiguredInstance in interface ILogger
+
+
+
+ +

+isLoggable

+
+public boolean isLoggable(Level level)
+
+
Check if a message of the given level would actually be logged + by this logger.
+
Specified by:
isLoggable in interface ILogger
Parameters:
level - a message logging level
Returns:
true if the given message level is currently being logged.
+
+
+
+ +

+severe

+
+public void severe(java.lang.String sourceClass,
+                   java.lang.String sourceMethod,
+                   java.lang.String msg)
+
+
Log a SEVERE message, specifying source class and method. +

+ If the logger is currently enabled for the SEVERE message + level then the given message is forwarded to all the + registered output Handler objects. +

+
Specified by:
severe in interface ILogger
Parameters:
sourceClass - name of class that issued the logging request
sourceMethod - name of method that issued the logging request
msg - The string message (or a key in the message catalog)
+
+
+
+ +

+warning

+
+public void warning(java.lang.String sourceClass,
+                    java.lang.String sourceMethod,
+                    java.lang.String msg)
+
+
Log a WARNING message, specifying source class and method. +

+ If the logger is currently enabled for the WARNING message + level then the given message is forwarded to all the + registered output Handler objects. +

+
Specified by:
warning in interface ILogger
Parameters:
sourceClass - name of class that issued the logging request
sourceMethod - name of method that issued the logging request
msg - The string message (or a key in the message catalog)
+
+
+
+ +

+info

+
+public void info(java.lang.String sourceClass,
+                 java.lang.String sourceMethod,
+                 java.lang.String msg)
+
+
Log an INFO message, specifying source class and method. +

+ If the logger is currently enabled for the INFO message + level then the given message is forwarded to all the + registered output Handler objects. +

+
Specified by:
info in interface ILogger
Parameters:
sourceClass - name of class that issued the logging request
sourceMethod - name of method that issued the logging request
msg - The string message (or a key in the message catalog)
+
+
+
+ +

+config

+
+public void config(java.lang.String sourceClass,
+                   java.lang.String sourceMethod,
+                   java.lang.String msg)
+
+
Log a CONFIG message, specifying source class and method. +

+ If the logger is currently enabled for the CONFIG message + level then the given message is forwarded to all the + registered output Handler objects. +

+
Specified by:
config in interface ILogger
Parameters:
sourceClass - name of class that issued the logging request
sourceMethod - name of method that issued the logging request
msg - The string message (or a key in the message catalog)
+
+
+
+ +

+fine

+
+public void fine(java.lang.String sourceClass,
+                 java.lang.String sourceMethod,
+                 java.lang.String msg)
+
+
Log a FINE message, specifying source class and method. +

+ If the logger is currently enabled for the FINE message + level then the given message is forwarded to all the + registered output Handler objects. +

+
Specified by:
fine in interface ILogger
Parameters:
sourceClass - name of class that issued the logging request
sourceMethod - name of method that issued the logging request
msg - The string message (or a key in the message catalog)
+
+
+
+ +

+finer

+
+public void finer(java.lang.String sourceClass,
+                  java.lang.String sourceMethod,
+                  java.lang.String msg)
+
+
Log a FINER message, specifying source class and method. +

+ If the logger is currently enabled for the FINER message + level then the given message is forwarded to all the + registered output Handler objects. +

+
Specified by:
finer in interface ILogger
Parameters:
sourceClass - name of class that issued the logging request
sourceMethod - name of method that issued the logging request
msg - The string message (or a key in the message catalog)
+
+
+
+ +

+finest

+
+public void finest(java.lang.String sourceClass,
+                   java.lang.String sourceMethod,
+                   java.lang.String msg)
+
+
Log a FINEST message, specifying source class and method. +

+ If the logger is currently enabled for the FINEST message + level then the given message is forwarded to all the + registered output Handler objects. +

+
Specified by:
finest in interface ILogger
Parameters:
sourceClass - name of class that issued the logging request
sourceMethod - name of method that issued the logging request
msg - The string message (or a key in the message catalog)
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+ + + Propchange: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Logger.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Watchdog.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Watchdog.html?rev=1206901&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Watchdog.html (added) +++ incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Watchdog.html Sun Nov 27 23:04:57 2011 @@ -0,0 +1,293 @@ + + + + + + +: Class Watchdog + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +com.sun.star.util.logging +
+Class Watchdog

+
+java.lang.Object
+  |
+  +--java.lang.Thread
+        |
+        +--com.sun.star.util.logging.Watchdog
+
+
+
+
public class Watchdog
extends java.lang.Thread
+ +

+A simple watchdog thread that monitors a file in + certain intervals for changes +

+

+ +

+ + + + + + + + + + + + + +
Fields inherited from class java.lang.Thread
MAX_PRIORITY, +MIN_PRIORITY, +NORM_PRIORITY
+  + + + + + + + + + + +
+Constructor Summary
Watchdog(java.lang.String sFilename) + +
+          Configure the Watchdog with the file to be watched
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidrun() + +
+          Starts the thread
+protected  voidwatch() + +
+          Checks the file for changes
+  + + + + + + + +
Methods inherited from class java.lang.Thread
activeCount, +checkAccess, +countStackFrames, +currentThread, +destroy, +dumpStack, +enumerate, +getContextClassLoader, +getName, +getPriority, +getThreadGroup, +interrupt, +interrupted, +isAlive, +isDaemon, +isInterrupted, +join, +join, +join, +resume, +setContextClassLoader, +setDaemon, +setName, +setPriority, +sleep, +sleep, +start, +stop, +stop, +suspend, +toString, +yield
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+Watchdog

+
+public Watchdog(java.lang.String sFilename)
+
+
Configure the Watchdog with the file to be watched
+
Parameters:
sFilename - file to be watched
+
+
+ + + + + + + + +
+Method Detail
+ +

+run

+
+public void run()
+
+
Starts the thread
+
Overrides:
run in class java.lang.Thread
+
+
+
+ +

+watch

+
+protected void watch()
+
+
Checks the file for changes
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+ + + Propchange: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/Watchdog.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapper.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapper.html?rev=1206901&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapper.html (added) +++ incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapper.html Sun Nov 27 23:04:57 2011 @@ -0,0 +1,472 @@ + + + + + + +: Class log4jLoggerWrapper + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +com.sun.star.util.logging +
+Class log4jLoggerWrapper

+
+java.lang.Object
+  |
+  +--org.apache.log4j.Category
+        |
+        +--com.sun.star.util.logging.log4jLoggerWrapper
+
+
+
+
public class log4jLoggerWrapper
extends Category
implements ILogger
+ +

+

+ +

+ + + + + + + + + + + + + +
Fields inherited from class org.apache.log4j.Category
additive, +DEFAULT_CONFIGURATION_FILE, +DEFAULT_CONFIGURATION_KEY, +DEFAULT_INIT_OVERRIDE_KEY, +defaultHierarchy, +hierarchy, +name, +parent, +priority, +resourceBundle
+  + + + + + + + + + + +
+Constructor Summary
log4jLoggerWrapper(java.lang.String name) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconfig(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+           
+ voidfine(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+           
+ voidfiner(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+           
+ voidfinest(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+           
+ ILoggergetConfiguredInstance() + +
+           
+ voidinfo(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+           
+ booleanisLoggable(Level level) + +
+           
+ voidsevere(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+           
+ voidwarning(java.lang.String sourceClass, + java.lang.String sourceMethod, + java.lang.String msg) + +
+           
+  + + + + + + + +
Methods inherited from class org.apache.log4j.Category
addAppender, +assert, +callAppenders, +debug, +debug, +error, +error, +exists, +fatal, +fatal, +forcedLog, +getAdditivity, +getAllAppenders, +getAppender, +getChainedPriority, +getCurrentCategories, +getDefaultHierarchy, +getHierarchy, +getInstance, +getInstance, +getInstance, +getName, +getPriority, +getResourceBundle, +getResourceBundleString, +getRoot, +info, +info, +isDebugEnabled, +isEnabledFor, +isInfoEnabled, +l7dlog, +l7dlog, +log, +log, +log, +removeAllAppenders, +removeAppender, +removeAppender, +setAdditivity, +setPriority, +setResourceBundle, +shutdown, +warn, +warn
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+log4jLoggerWrapper

+
+public log4jLoggerWrapper(java.lang.String name)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getConfiguredInstance

+
+public ILogger getConfiguredInstance()
+
+
+
Specified by:
getConfiguredInstance in interface ILogger
+
+
+
+ +

+isLoggable

+
+public boolean isLoggable(Level level)
+
+
+
Specified by:
isLoggable in interface ILogger
+
+
+
+ +

+severe

+
+public void severe(java.lang.String sourceClass,
+                   java.lang.String sourceMethod,
+                   java.lang.String msg)
+
+
+
Specified by:
severe in interface ILogger
+
+
+
+ +

+warning

+
+public void warning(java.lang.String sourceClass,
+                    java.lang.String sourceMethod,
+                    java.lang.String msg)
+
+
+
Specified by:
warning in interface ILogger
+
+
+
+ +

+info

+
+public void info(java.lang.String sourceClass,
+                 java.lang.String sourceMethod,
+                 java.lang.String msg)
+
+
+
Specified by:
info in interface ILogger
+
+
+
+ +

+config

+
+public void config(java.lang.String sourceClass,
+                   java.lang.String sourceMethod,
+                   java.lang.String msg)
+
+
+
Specified by:
config in interface ILogger
+
+
+
+ +

+fine

+
+public void fine(java.lang.String sourceClass,
+                 java.lang.String sourceMethod,
+                 java.lang.String msg)
+
+
+
Specified by:
fine in interface ILogger
+
+
+
+ +

+finer

+
+public void finer(java.lang.String sourceClass,
+                  java.lang.String sourceMethod,
+                  java.lang.String msg)
+
+
+
Specified by:
finer in interface ILogger
+
+
+
+ +

+finest

+
+public void finest(java.lang.String sourceClass,
+                   java.lang.String sourceMethod,
+                   java.lang.String msg)
+
+
+
Specified by:
finest in interface ILogger
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+ + + Propchange: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapper.html ------------------------------------------------------------------------------ svn:eol-style = native Added: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapperFactory.html URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapperFactory.html?rev=1206901&view=auto ============================================================================== --- incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapperFactory.html (added) +++ incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapperFactory.html Sun Nov 27 23:04:57 2011 @@ -0,0 +1,219 @@ + + + + + + +: Class log4jLoggerWrapperFactory + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +com.sun.star.util.logging +
+Class log4jLoggerWrapperFactory

+
+java.lang.Object
+  |
+  +--com.sun.star.util.logging.log4jLoggerWrapperFactory
+
+
+
+
public class log4jLoggerWrapperFactory
extends java.lang.Object
implements CategoryFactory
+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
log4jLoggerWrapperFactory() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ CategorymakeNewCategoryInstance(java.lang.String name) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+log4jLoggerWrapperFactory

+
+public log4jLoggerWrapperFactory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+makeNewCategoryInstance

+
+public Category makeNewCategoryInstance(java.lang.String name)
+
+
+
Specified by:
makeNewCategoryInstance in interface CategoryFactory
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+ + + Propchange: incubator/ooo/ooo-site/trunk/content/udk/java/ref/logging/com/sun/star/util/logging/log4jLoggerWrapperFactory.html ------------------------------------------------------------------------------ svn:eol-style = native