You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ja...@apache.org on 2008/11/30 17:41:54 UTC

svn commit: r721851 - in /incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log: Logger.java LoggerFactory.java LoggerImpl.java

Author: jalkanen
Date: Sun Nov 30 08:41:53 2008
New Revision: 721851

URL: http://svn.apache.org/viewvc?rev=721851&view=rev
Log:
Removed a number of Checkstyle warnings.

Modified:
    incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/Logger.java
    incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerFactory.java
    incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerImpl.java

Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/Logger.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/Logger.java?rev=721851&r1=721850&r2=721851&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/Logger.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/Logger.java Sun Nov 30 08:41:53 2008
@@ -45,12 +45,34 @@
 
     void debug( String string, Throwable t );
 
+    /**
+     *  Checks if ERROR messages are enabled for this Logger.
+     *  
+     *  @return True, if ERROR messages are enabled.
+     */
+
     boolean isErrorEnabled();
 
+    /**
+     *  Checks if WARN messages are enabled for this Logger.
+     *  
+     *  @return True, if WARN messages are enabled.
+     */
+
     boolean isWarnEnabled();
 
+    /**
+     *  Checks if INFO messages are enabled for this Logger.
+     *  
+     *  @return True, if INFO messages are enabled.
+     */
     boolean isInfoEnabled();
 
+    /**
+     *  Checks if DEBUG messages are enabled for this Logger.
+     *  
+     *  @return True, if DEBUG messages are enabled.
+     */
     boolean isDebugEnabled();
 
 }

Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerFactory.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerFactory.java?rev=721851&r1=721850&r2=721851&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerFactory.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerFactory.java Sun Nov 30 08:41:53 2008
@@ -48,13 +48,13 @@
  * @author Harry Metske
  * @since 3.0
  */
-public class LoggerFactory
+public final class LoggerFactory
 {
     private static boolean c_log4jPresent = true;
 
-    public static final String SLF4J_LOG4J_ADAPTER_CLASS = "org.slf4j.impl.Log4jLoggerAdapter";
+    private static final String SLF4J_LOG4J_ADAPTER_CLASS = "org.slf4j.impl.Log4jLoggerAdapter";
 
-    public static final String LOG4J_LOGGER_CLASS = "org.apache.log4j.Logger";
+    private static final String LOG4J_LOGGER_CLASS = "org.apache.log4j.Logger";
 
     private static HashMap<String, LoggerImpl> c_registeredLoggers = new HashMap<String, LoggerImpl>( 200 );
 
@@ -64,8 +64,16 @@
     }
 
     /**
-     * @param loggerName
-     * @return <code>
+     *  Private constructor prevents instantiation.
+     */
+    private LoggerFactory()
+    {}
+    
+    /**
+     * Returns a Logger instance, and also, if it is a Log4J logger, registers the Logging MBean.
+     * 
+     * @param loggerName Logger to find.
+     * @return A Logger instance. 
      */
     public static final synchronized Logger getLogger( String loggerName )
     {
@@ -103,7 +111,7 @@
             // first instantiate the logger: Logger.getLogger(loggerName)
             //
             @SuppressWarnings("unused")
-            Object slf4j_log4j_Impl = Class.forName( SLF4J_LOG4J_ADAPTER_CLASS);
+            Object slf4jLog4jImpl = Class.forName( SLF4J_LOG4J_ADAPTER_CLASS);
             //
             Object log4jLogger = Class.forName(LOG4J_LOGGER_CLASS );
             Class loggerClass = Class.forName(LOG4J_LOGGER_CLASS  );
@@ -137,6 +145,12 @@
         }
     }
 
+    /**
+     *  Utility method for locating a Logger based on a Class.
+     *  
+     *  @param clazz The Class to find a Logger for.
+     *  @return A Logger instance.
+     */
     public static final Logger getLogger( Class clazz )
     {
         return getLogger( clazz.getName() );

Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerImpl.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerImpl.java?rev=721851&r1=721850&r2=721851&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerImpl.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/log/LoggerImpl.java Sun Nov 30 08:41:53 2008
@@ -33,68 +33,81 @@
     Logger m_slf4jLogger = null;
 
     /**
-     * @param loggerName
+     * @param loggerName The name of the SFL4J Logger to find
      */
     protected LoggerImpl( String loggerName )
     {
         m_slf4jLogger = org.slf4j.LoggerFactory.getLogger( loggerName );
     }
 
+    /** {@inheritDoc} */
+    
     public void error( String string )
     {
         m_slf4jLogger.error( string );
     }
 
+    /** {@inheritDoc} */
     public void warn( String string )
     {
         m_slf4jLogger.warn( string );
     }
 
+    /** {@inheritDoc} */
     public void info( String string )
     {
         m_slf4jLogger.info( string );
     }
 
+    /** {@inheritDoc} */
     public void debug( String arg0 )
     {
         m_slf4jLogger.debug( arg0 );
     }
 
+    /** {@inheritDoc} */
     public void error( String string, Throwable t )
     {
         m_slf4jLogger.error( string, t );
     }
 
+    /** {@inheritDoc} */
     public void warn( String string, Throwable t )
     {
         m_slf4jLogger.warn( string, t );
     }
 
+    /** {@inheritDoc} */
     public void info( String string, Throwable t )
     {
         m_slf4jLogger.info( string, t );
     }
 
+    /** {@inheritDoc} */
     public void debug( String string, Throwable t )
     {
         m_slf4jLogger.debug( string, t );
     }
 
+    /** {@inheritDoc} */
     public boolean isErrorEnabled()
     {
         return m_slf4jLogger.isErrorEnabled();
     }
 
+    /** {@inheritDoc} */
     public boolean isWarnEnabled()
     {
         return m_slf4jLogger.isWarnEnabled();
     }
 
+    /** {@inheritDoc} */
     public boolean isInfoEnabled()
     {
         return m_slf4jLogger.isInfoEnabled();
     }
 
+    /** {@inheritDoc} */
     public boolean isDebugEnabled()
     {
         return m_slf4jLogger.isDebugEnabled();