org.jdesktop.swingx.error.ErrorReporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swingx-all Show documentation

Fork of the inactive swingx-all library

There is a newer version: 1.7.2

/*
 * $Id: ErrorReporter.java 3166 2009-01-02 13:27:18Z rah003 $
 *
 * 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;

/**
 * ErrorReporter is used by {@link org.jdesktop.swingx.JXErrorPane} to
 * implement a pluggable error reporting API. For example, a
 * JXErrorPane may use an EmailErrorReporter, or a
 * {@code LogErrorReporter}, or perhaps even an
 * RSSErrorReporter.
 *
 * @author Alexander Zuev
 * @author rbair
 */
public interface ErrorReporter {

    /**
     * Reports an error based on the given {@link ErrorInfo}. This
     * method may be a long running method, and so should not block the EDT in
     * any way. If an error occurs while reporting the error, it must not
     * throw an exception from this method. If an error dialog causes another error,
     * it should be silently swallowed. If proper heuristics can be used, an attempt
     * can be made some time later to re-report failed error reports, but such attempts
     * should be transparent to the user.
     *
     * @param info encapsulates all information to report using this facility. Must not be null.
     * @throws NullPointerException if the info param is null
     */
    void reportError(ErrorInfo info) throws NullPointerException;
}