/*
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */


package org.apache.commons.digester;

import java.io.PrintWriter;

/** 
 * <p> Standard digester logger.
 * This logs to <code>System.out</code> by default,
 * or to a given <code>PrintWriter</code>.
 *
 * <p> This class allows compatibility with existing code.
 */
public class BaseDigesterLogger implements DigesterLogger {
    
    // --------------------------------------------------------- Constructors
    
    /**  
     * <p> Base constructor.
     * 
     */  
    public BaseDigesterLogger() {}
    
    /** 
     * Convenience constructor which calls {@link #setWriter}.
     */
    public BaseDigesterLogger(PrintWriter writer)
    {
        this.writer=writer;
    }


    // --------------------------------------------------- Instance Variables


    /**
     * The PrintWriter to which we should send log output, or
     * <code>null</code> to write to <code>System.out</code>.
     */
    protected PrintWriter writer = null;


    // ----------------------------------------------------------- Properties

    /**
     * <p> Return the current logging writer.
     *
     * If this is null, then logging will go to <code>System.out</code>.
     */
    public PrintWriter getWriter() {

        return (this.writer);

    }


    /**
     * Return the current logging writer.
     *
     * @param writer The new PrintWriter, or <code>null</code> for
     *  <code>System.out</code>.
     */
    public void setWriter(PrintWriter writer) {

        this.writer = writer;

    }
    

    // ------------------------------------------------------ Logging Methods


    /**
     * Log a message to the associated log writer.
     * If the current writer is null, send to <code>System.out</code>
     *
     * @param message The message to be logged
     */
    public void log(String message) {

        if (writer == null)
            System.out.println(message);
        else
            writer.println(message);

    }


    /**
     * Log a message to the associated log writer.
     * If the current writer is null, send to <code>System.out</code>
     *
     * @param message The message to be logged
     * @param exception The associated exception to be logged
     */
    public void log(String message, Throwable exception) {

        if (writer == null) {
            System.out.println(message);
            exception.printStackTrace(System.out);
        } else {
            writer.println(message);
            exception.printStackTrace(writer);
        }

    }
}
