src/net/pterodactylus/fcp/highlevel/HighLevelProgressListener.java

   1 /*
   2  * jFCPlib-high-level-client - HighLevelProgressListener.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp.highlevel;
  21
  22 import java.util.EventListener;
  23
  24 /**
  25  * Interface for objects that want to observe the progression of requests.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  * @version $Id$
  29  */
  30 public interface HighLevelProgressListener extends EventListener {
  31
  32         /**
  33          * Notifies a listener that the request with the given identifier has made
  34          * some progress.
  35          *
  36          * @param highLevelClient
  37          *            The high-level client that emitted this event
  38          * @param identifier
  39          *            The identifier of the request
  40          * @param highLevelProgress
  41          *            The progress of the request
  42          */
  43         public void progressReceived(HighLevelClient highLevelClient, String identifier, HighLevelProgress highLevelProgress);
  44
  45 }