EngineAbstract.java

/**
   This file is part of Waarp Project.

   Copyright 2009, Frederic Bregier, and individual contributors by the @author
   tags. See the COPYRIGHT.txt in the distribution for a full listing of
   individual contributors.

   All Waarp Project is free software: you can redistribute it and/or 
   modify it under the terms of the GNU General Public License as published 
   by the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   Waarp 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with Waarp .  If not, see <http://www.gnu.org/licenses/>.
 */
package org.waarp.common.service;

/**
 * Abstract class to implement to be able to start or shutdown a service
 * 
 * @author Frederic Bregier
 *
 */
public abstract class EngineAbstract extends Thread {
    /**
     * Shutdown the service
     */
    public abstract void shutdown();

    /**
     * 
     * @return True if the service is shutdown
     */
    public abstract boolean isShutdown();

    /**
     * Return when the service is shutdown
     * 
     * @return True if the service is correctly shutdown, else False if in error
     */
    public abstract boolean waitShutdown() throws InterruptedException;
}