src/net/pterodactylus/jsite/core/InsertListener.java

   1 /*
   2  * jSite2 - InsertListener.java - Copyright © 2008 David Roden
   3  *
   4  * This program is free software; you can redistribute it and/or modify it under
   5  * the terms of the GNU General Public License as published by the Free Software
   6  * Foundation; either version 2 of the License, or (at your option) any later
   7  * version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  12  * details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  16  * Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package net.pterodactylus.jsite.core;
  20
  21 import java.util.EventListener;
  22
  23 /**
  24  * Interface for objects that want to be notified on events emitted by the
  25  * {@link InsertManager}.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  */
  29 public interface InsertListener extends EventListener {
  30
  31         /**
  32          * Notifies a listener that an insert was added.
  33          *
  34          * @param insert
  35          *            The insert that was added
  36          */
  37         public void insertAdded(Insert insert);
  38
  39         /**
  40          * Notifies a listener that an insert was removed.
  41          *
  42          * @param insert
  43          *            The insert that was removed
  44          */
  45         public void insertRemoved(Insert insert);
  46
  47         /**
  48          * Notifies a listener that an insert was started.
  49          *
  50          * @param insert
  51          *            The insert that was started
  52          */
  53         public void insertStarted(Insert insert);
  54
  55         /**
  56          * Notifies a listener that an insert made some progress.
  57          *
  58          * @param insert
  59          *            The insert that made some progress
  60          */
  61         public void insertProgressed(Insert insert);
  62
  63         /**
  64          * Notifies listeners that an insert generated a URI.
  65          *
  66          * @param insert
  67          *            The insert that generated a URI
  68          * @param uri
  69          *            The generated URI
  70          */
  71         public void insertGeneratedURI(Insert insert, String uri);
  72
  73         /**
  74          * Notifies a listener that an insert has finished.
  75          *
  76          * @param insert
  77          *            The insert that has finished
  78          */
  79         public void insertFinished(Insert insert);
  80
  81 }