org.jboss.logging.util.LoggerWriter Maven / Gradle / Ivy

Go to download
/*
  * JBoss, Home of Professional Open Source
  * Copyright 2005, JBoss Inc., and individual contributors as indicated
  * by the @authors tag. See the copyright.txt in the distribution for a
  * full listing of individual contributors.
  *
  * This is free software; you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License as
  * published by the Free Software Foundation; either version 2.1 of
  * the License, or (at your option) any later version.
  *
  * This software is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this software; if not, write to the Free
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
package org.jboss.logging.util;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;

import org.apache.log4j.Logger;
import org.apache.log4j.Level;

/**
 *  A subclass of PrintWriter that redirects its output to a log4j Logger. 
 *
 *  This class is used to have something to give api methods that require a
 *  PrintWriter for logging. JBoss-owned classes of this nature generally ignore
 *  the PrintWriter and do their own log4j logging.
 *
 * @author     David Jencks
 *      .
 * @created    August 19, 2001
 * @version    $$
 */
public class LoggerWriter
   extends PrintWriter
{
   /**
    *  Redirect logging to the indicated logger using Level.INFO
    *
    * @param  logger  Description of Parameter
    */
   public LoggerWriter( final Logger logger ) {
      this( logger, Level.INFO );
   }

   /**
    *  Redirect logging to the indicated logger using the given level. The
    *  ps is simply passed to super but is not used.
    *
    * @param  logger  Description of Parameter
    * @param  level  Description of Parameter
    */
   public LoggerWriter( final Logger logger,
         final Level level ) {
      super( new InternalLoggerWriter( logger, level ), true );
   }

   /**
    * @created    August 19, 2001
    */
   static class InternalLoggerWriter extends Writer {
      private Logger logger;
      private Level level;
      private boolean closed;

      public InternalLoggerWriter( final Logger logger, final Level level ) {
         lock = logger;
         //synchronize on this logger
         this.logger = logger;
         this.level = level;
      }

      public void write( char[] cbuf, int off, int len )
         throws IOException {
         if ( closed ) {
            throw new IOException( "Called write on closed Writer" );
         }
         // Remove the end of line chars
         while ( len > 0 && ( cbuf[len - 1] == '\n' || cbuf[len - 1] == '\r' ) ) {
            len--;
         }
         if ( len > 0 ) {
            logger.log( level, String.copyValueOf( cbuf, off, len ) );
         }
      }


      public void flush()
         throws IOException {
         if ( closed ) {
            throw new IOException( "Called flush on closed Writer" );
         }
      }

      public void close() {
         closed = true;
      }
   }

}