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

   1 /*
   2  * fcplib - HighLevelCallbackListener.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 be notified as soon as a
  26  * {@link HighLevelCallback} received a result.
  27  *
  28  * @param <R>
  29  *            The type of the high-level operation progress
  30  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  31  * @version $Id$
  32  */
  33 public interface HighLevelCallbackListener<R extends HighLevelResult> extends EventListener {
  34
  35         /**
  36          * Notifies a listener that the given callback received a result. Use
  37          * {@link HighLevelCallback#getResult()} to retrieve the result.
  38          *
  39          * @param highLevelCallback
  40          *            The callback that received a result
  41          */
  42         public void gotResult(HighLevelCallback<R> highLevelCallback);
  43
  44 }