src/main/java/net/pterodactylus/irc/event/DccDownloadFailed.java

   1 /*
   2  * XdccDownloader - DccDownloadFailed.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.irc.event;
  19
  20 import net.pterodactylus.irc.DccReceiver;
  21
  22 import com.google.common.base.Optional;
  23
  24 /**
  25  * Notifies a listener that a DCC download has failed.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public class DccDownloadFailed {
  30
  31         /** The DCC receiver. */
  32         private final DccReceiver dccReceiver;
  33
  34         /** The cause of the failure. */
  35         private final Throwable cause;
  36
  37         /**
  38          * Creates a new DCC download failed event.
  39          *
  40          * @param dccReceiver
  41          *              The DCC receiver
  42          * @param cause
  43          *              The cause of the failure (may be {@code null})
  44          */
  45         public DccDownloadFailed(DccReceiver dccReceiver, Throwable cause) {
  46                 this.dccReceiver = dccReceiver;
  47                 this.cause = cause;
  48         }
  49
  50         //
  51         // ACCESSORS
  52         //
  53
  54         /**
  55          * Returns the DCC receiver.
  56          *
  57          * @return The DCC receiver
  58          */
  59         public DccReceiver dccReceiver() {
  60                 return dccReceiver;
  61         }
  62
  63         /**
  64          * Returns the cause of the failure.
  65          *
  66          * @return The cause of the failure, or {@link Optional#absent()} if the cause
  67          *         is unknown
  68          */
  69         public Optional<Throwable> cause() {
  70                 return Optional.fromNullable(cause);
  71         }
  72
  73 }