View Javadoc
1   /**
2    * This file Copyright (c) 2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module;
35  
36  import info.magnolia.event.Event;
37  import info.magnolia.event.EventHandler;
38  
39  /**
40   * Event sent when a module should be stopped by the {@link info.magnolia.module.ModuleManager}.
41   */
42  public class StopModuleEvent implements Event<StopModuleEvent.Handler> {
43  
44      private final String moduleName;
45  
46      public StopModuleEvent(String moduleName) {
47          this.moduleName = moduleName;
48      }
49  
50      @Override
51      public void dispatch(Handler handler) {
52          handler.onModuleStop(this);
53      }
54  
55      public String getModuleName() {
56          return moduleName;
57      }
58  
59      /**
60       * Event handler for {@link StopModuleEvent}.
61       */
62      public interface Handler extends EventHandler {
63          void onModuleStop(StopModuleEvent event);
64      }
65  }