001/*
002 * $Id: ErrorListener.java 2979 2008-07-08 01:32:06Z kschaefe $
003 *
004 * Copyright 2006 Sun Microsystems, Inc., 4150 Network Circle,
005 * Santa Clara, California 95054, U.S.A. All rights reserved.
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015 * Lesser General Public License for more details.
016 *
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this library; if not, write to the Free Software
019 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
020 */
021
022package org.jdesktop.swingx.error;
023
024import java.util.EventListener;
025
026/**
027 * ErrorListener defines the interface for an object which listens to errors generated
028 * by a JX Swing component. ErrorEvents are only generated for internal un-recoverable errors
029 * that cannot be thrown. An example would be an internal Action implementation that cannot
030 * throw an Exception directly because the ActionListener interface forbids it. Exceptions
031 * which can be throw directly (say from the constructor of the JX component) should not use
032 * the ErrorListener mechanism.
033 *
034 * @see ErrorEvent
035 * @see ErrorSupport
036 * @author Joshua Marinacci joshua.marinacci@sun.com
037 */
038public interface ErrorListener extends EventListener {
039    
040    /**
041     * Tells listeners that an error has occured within the watched component.
042     * @param event 
043     */
044    public void errorOccured(ErrorEvent event);
045}