src/main/java/net/pterodactylus/sonitus/data/event/SourceFinishedEvent.java

   1 /*
   2  * Sonitus - SourceFinishedEvent.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sonitus.data.event;
  19
  20 import net.pterodactylus.sonitus.data.Source;
  21
  22 /**
  23  * Event that is sent to an {@link com.google.common.eventbus.EventBus} when
  24  * a {@link Source} is no longer in use.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public class SourceFinishedEvent {
  29
  30         /** The source that is no longer in use. */
  31         private final Source source;
  32
  33         /**
  34          * Creates a new source finished event.
  35          *
  36          * @param source
  37          *              The source that is no longer in use
  38          */
  39         public SourceFinishedEvent(Source source) {
  40                 this.source = source;
  41         }
  42
  43         /**
  44          * Returns the source that is no longer in use
  45          *
  46          * @return The source that is no longer in use
  47          */
  48         public Source source() {
  49                 return source;
  50         }
  51
  52 }