/Users/richardallenbair/Documents/Source/Projects/nonsense/swingx/src/beaninfo/LogErrorReporter_API.java
/*
 * $Id: LogErrorReporter_API.html 1362 2006-08-24 20:06:25Z rbair $
 *
 * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
 * Santa Clara, California 95054, U.S.A. All rights reserved.
 *
 * This library 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 library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */ 

package org.jdesktop.swingx.error;

import java.util.logging.Logger;
import org.jdesktop.swingx.JavaBean;

/**
 * <p>A simple {@link ErrorReporter} that sends errors to a log file, using the
 * standard logging facility. This allows the user to decide which errors are
 * worth logging, and which aren't. It is anticipated that this class will
 * prove more useful in admin or power user applications, as opposed to consumer
 * oriented applications. However, if combined with some other error reporter
 * such as {@link EmailErrorReporter}, this class may prove useful even
 * in consumer applications.</p>
 *
 * @author rbair
 */
public class LogErrorReporter extends JavaBean implements ErrorReporter {
    /** Creates a new instance of <code>LogErrorReporter</code> */
    public LogErrorReporter();
    
    /**
     * Sets the <code>Logger</code> to log error reports to. The specified param
     * may be null which will cause the LogErrorReporter to log nothing.
     *
     * @param log the <code>Logger</code> which will receive error reports
     */
    public void setLog(Logger log);
    
    /**
     * Gets the log. May be null.
     *
     * @return the <code>Logger</code> which will process error reports
     */
    public Logger getLog();

    /**
     * @inheritDoc
     */
    public void reportError(ErrorInfo info);
}