src/main/java/net/pterodactylus/sone/core/event/SoneInsertAbortedEvent.java

   1 /*
   2  * Sone - SoneInsertAbortedEvent.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.sone.core.event;
  19
  20 import net.pterodactylus.sone.data.Sone;
  21
  22 /**
  23  * Event that signals that a {@link Sone} insert was aborted.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public class SoneInsertAbortedEvent extends SoneEvent {
  28
  29         /** The cause of the abortion. */
  30         private final Throwable cause;
  31
  32         /**
  33          * Creates a new “Sone was inserted” event.
  34          *
  35          * @param sone
  36          *            The Sone that was inserted
  37          * @param cause
  38          *            The cause of the abortion
  39          */
  40         public SoneInsertAbortedEvent(Sone sone, Throwable cause) {
  41                 super(sone);
  42                 this.cause = cause;
  43         }
  44
  45         //
  46         // ACCESSORS
  47         //
  48
  49         /**
  50          * Returns the cause of the abortion.
  51          *
  52          * @return The cause of the abortion (may be {@code null})
  53          */
  54         public Throwable cause() {
  55                 return cause;
  56         }
  57
  58 }