src/java/org/apache/log4j/chainsaw/ShutdownListener.java

/*
 * Copyright 1999,2004 The Apache Software Foundation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.log4j.chainsaw;

import java.util.EventListener;

/**
 * Chainsaw notifies these Listeners when the user has requested
 * it to shutdown.
 * 
 * Listeners should use this opportunity to release any resources
 * and/or perform any clean up activity.
 * 
 * Listeners should <B>NOT</b> perform the action of actual shutting down
 * however (i.e. do not call System.exit()).
 * 
 * @see LogUI#setShutdownAction(Action)
 * 
 * @author Paul Smith <psmith@apache.org>
 */
public interface ShutdownListener extends EventListener{

  public void shuttingDown();
}