001/*
002 * Copyright (c) 2011 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: crawl $'
006 * '$Date: 2011-06-15 23:22:31 +0000 (Wed, 15 Jun 2011) $' 
007 * '$Revision: 27732 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.module;
031
032/** An interface for module cleanup. When Kepler exits,
033 *  org.kepler.Kepler uses this interface to cleanup each module
034 *  in modules.txt.
035 *  <b>NOTE: The name of the class implementing this interface
036 *  must be called org.kepler.module.NNN.Shutdown, where NNN
037 *  is the name of the module.</b>
038 *
039 *
040 * @author Daniel Crawl
041 * @version $Id: ModuleShutdownable.java 27732 2011-06-15 23:22:31Z crawl $
042 */
043
044public interface ModuleShutdownable
045{
046    /** Perform any module-specific cleanup. */
047    public void shutdownModule();
048}