001/*
002 * This file is part of McIDAS-V
003 *
004 * Copyright 2007-2024
005 * Space Science and Engineering Center (SSEC)
006 * University of Wisconsin - Madison
007 * 1225 W. Dayton Street, Madison, WI 53706, USA
008 * https://www.ssec.wisc.edu/mcidas/
009 * 
010 * All Rights Reserved
011 * 
012 * McIDAS-V is built on Unidata's IDV and SSEC's VisAD libraries, and
013 * some McIDAS-V source code is based on IDV and VisAD source code.  
014 * 
015 * McIDAS-V is free software; you can redistribute it and/or modify
016 * it under the terms of the GNU Lesser Public License as published by
017 * the Free Software Foundation; either version 3 of the License, or
018 * (at your option) any later version.
019 * 
020 * McIDAS-V is distributed in the hope that it will be useful,
021 * but WITHOUT ANY WARRANTY; without even the implied warranty of
022 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
023 * GNU Lesser Public License for more details.
024 * 
025 * You should have received a copy of the GNU Lesser Public License
026 * along with this program.  If not, see https://www.gnu.org/licenses/.
027 */
028
029package edu.wisc.ssec.mcidasv.util.pathwatcher;
030
031// Taken from https://gist.github.com/hindol-viz/394ebc553673e2cd0699
032
033/**
034 * Interface definition for services.
035 */
036public interface Service {
037    
038    /**
039     * Starts the service. This method blocks until the service has completely
040     * started.
041     *
042     * @throws Exception if there was a problem starting the service
043     */
044    void start() throws Exception;
045    
046    /**
047     * Stops the service. This method blocks until the service has completely
048     * shut down.
049     */
050    void stop();
051    
052    /**
053     * Checks to see if the service is still running.
054     *
055     * @return {@code true} if the service is running, {@code false} otherwise.
056     */
057    boolean isRunning();
058}