001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2016-2018 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.core.events;
020
021import org.jgrapes.core.Channel;
022import org.jgrapes.core.Event;
023
024/**
025 * An event that causes an application to shut down. All components that
026 * generate events should stop doing so after handling this event.
027 */
028@SuppressWarnings("PMD.ShortClassName")
029public class Stop extends Event<Void> {
030
031    /**
032     * Create a new stop event with the event's channels set to 
033     * {@link Channel#BROADCAST}.
034     */
035    public Stop() {
036        super(Channel.BROADCAST);
037    }
038
039}