[jboss-svn-commits] JBL Code SVN: r29546 - labs/jbossrules/trunk/drools-api/src/main/java/org/drools/logger.

[jboss-svn-commits at lists.jboss.org]

Author: KrisVerlaenen
Date: 2009-10-07 11:03:40 -0400 (Wed, 07 Oct 2009)
New Revision: 29546

Modified:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/logger/KnowledgeRuntimeLoggerFactory.java
Log:
 - updated JavaDoc to add more info

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/logger/KnowledgeRuntimeLoggerFactory.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/logger/KnowledgeRuntimeLoggerFactory.java	2009-10-07 12:37:20 UTC (rev 29545)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/logger/KnowledgeRuntimeLoggerFactory.java	2009-10-07 15:03:40 UTC (rev 29546)
@@ -25,10 +25,12 @@
     private static KnowledgeRuntimeLoggerProvider knowledgeRuntimeLoggerProvider;
 
     /**
-     * Creates a file logger in the current thread and events are written as they happen.
-     * 
+     * Creates a file logger in the current thread. The file is in XML format, suitable for interpretation by Eclipse's Drools Audit View
+     * or other tools. Note that while events are written as they happen, the file will not be flushed until it is closed or the underlying
+     * file buffer is filled. If you need real time logging then use a Console Logger or a Threaded File Logger.
+     *
      * @param session
-     * @param fileName
+     * @param fileName - .log is appended to this.
      * @return
      */
     public static KnowledgeRuntimeLogger newFileLogger(KnowledgeRuntimeEventManager session,
@@ -38,11 +40,12 @@
     }
 
     /**
-     * Creates a file logger that executes in a different thread, where information is written on given intervals
-     * 
+     * Creates a file logger that executes in a different thread, where information is written on given intervals (in milliseconds).
+     * The file is in XML format, suitable for interpretation by Eclipse's Drools Audit View or other tools.
+     *
      * @param session
-     * @param fileName
-     * @param interval
+     * @param fileName - .log is appended to this.
+     * @param interval - in milliseconds.
      * @return
      */
     public static KnowledgeRuntimeLogger newThreadedFileLogger(KnowledgeRuntimeEventManager session,
@@ -54,7 +57,8 @@
     }
 
     /**
-     * Logs events to command line console
+     * Logs events to command line console. This is not in XML format, so it cannot be parsed
+     * by other tools, but is in real time and is more human readable.
      * 
      * @param session
      * @return