src/main/java/net/pterodactylus/sone/core/SoneInsertListener.java

   1 /*
   2  * Sone - SoneInsertListener.java - Copyright © 2011–2012 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;
  19
  20 import java.util.EventListener;
  21
  22 import net.pterodactylus.sone.data.Sone;
  23
  24 /**
  25  * Listener for Sone insert events.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public interface SoneInsertListener extends EventListener {
  30
  31         /**
  32          * Notifies a listener that a Sone is now being inserted.
  33          *
  34          * @param sone
  35          *            The Sone being inserted
  36          */
  37         public void insertStarted(Sone sone);
  38
  39         /**
  40          * Notifies a listener that a Sone has been successfully inserted.
  41          *
  42          * @param sone
  43          *            The Sone that was inserted
  44          * @param insertDuration
  45          *            The duration of the insert (in milliseconds)
  46          */
  47         public void insertFinished(Sone sone, long insertDuration);
  48
  49         /**
  50          * Notifies a listener that the insert of the given Sone was aborted.
  51          *
  52          * @param sone
  53          *            The Sone that was being inserted
  54          * @param cause
  55          *            The cause of the abortion (may be {@code null})
  56          */
  57         public void insertAborted(Sone sone, Throwable cause);
  58
  59 }