Implement the “ReceivedBookmarkFeed” message.
[jFCPlib.git] / src / net / pterodactylus / fcp / FcpListener.java
index 09a5f2a..151fcfe 100644 (file)
@@ -23,15 +23,14 @@ import java.util.EventListener;
 
 /**
  * Interface for objects that want to be notified on certain FCP events.
- *
+ * 
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- * @version $Id$
  */
 public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “NodeHello” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param nodeHello
@@ -42,7 +41,7 @@ public interface FcpListener extends EventListener {
        /**
         * Notifies a listener that a “CloseConnectionDuplicateClientName” message
         * was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param closeConnectionDuplicateClientName
@@ -52,7 +51,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “SSKKeypair” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received themessage
         * @param sskKeypair
@@ -62,7 +61,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “Peer” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param peer
@@ -72,7 +71,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that an “EndListPeers” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that recevied the message
         * @param endListPeers
@@ -82,7 +81,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PeerNote” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param peerNote
@@ -92,7 +91,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that an “EndListPeerNotes” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param endListPeerNotes
@@ -102,7 +101,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PeerRemoved” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param peerRemoved
@@ -112,7 +111,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “NodeData” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param nodeData
@@ -122,7 +121,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “TestDDAReply” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param testDDAReply
@@ -132,7 +131,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “TestDDAComplete” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param testDDAComplete
@@ -142,7 +141,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PersistentGet” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param persistentGet
@@ -152,7 +151,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PersistentPut” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param persistentPut
@@ -162,7 +161,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “EndListPersistentRequests” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param endListPersistentRequests
@@ -172,7 +171,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “URIGenerated” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param uriGenerated
@@ -182,7 +181,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “DataFound” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param dataFound
@@ -192,7 +191,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that an “AllData” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param allData
@@ -202,7 +201,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “SimpleProgress” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param simpleProgress
@@ -212,7 +211,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “StartedCompression” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param startedCompression
@@ -222,17 +221,17 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “FinishedCompression” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param finishedCompression
         *            The “FinishedCompression” message
         */
-       public void receviedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression);
+       public void receivedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression);
 
        /**
         * Notifies a listener that an “UnknownPeerNoteType” was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param unknownPeerNoteType
@@ -242,7 +241,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “UnknownNodeIdentifier” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param unknownNodeIdentifier
@@ -252,7 +251,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “ConfigData” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param configData
@@ -262,7 +261,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “GetFailed” message was recevied.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param getFailed
@@ -272,7 +271,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PutFailed” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param putFailed
@@ -282,7 +281,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that an “IdentifierCollision” message was receied.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param identifierCollision
@@ -292,7 +291,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PersistentPutDir” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param persistentPutDir
@@ -303,7 +302,7 @@ public interface FcpListener extends EventListener {
        /**
         * Notifies a listener that a “PersistentRequestRemoved” message was
         * received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param persistentRequestRemoved
@@ -313,7 +312,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “SubscribedUSKUpdate” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that recevied the message
         * @param subscribedUSKUpdate
@@ -323,7 +322,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PluginInfo” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param pluginInfo
@@ -333,7 +332,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that an “FCPPluginReply“ message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param fcpPluginReply
@@ -344,7 +343,7 @@ public interface FcpListener extends EventListener {
        /**
         * Notifies a listener that a “PersistentRequestModified” message was
         * received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param persistentRequestModified
@@ -354,7 +353,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PutSuccessful” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param putSuccessful
@@ -364,7 +363,7 @@ public interface FcpListener extends EventListener {
 
        /**
         * Notifies a listener that a “PutFetchable” message was received.
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param putFetchable
@@ -373,10 +372,20 @@ public interface FcpListener extends EventListener {
        public void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable);
 
        /**
-        * Notifies a listener that a “ProtocolError” was received.
+        * Notifies a listener that a bookmark was updated.
         *
         * @param fcpConnection
         *            The connection that received the message
+        * @param receivedBookmarkFeed
+        *            The “ReceivedBookmarkFeed” message
+        */
+       public void receivedBookmarkFeed(FcpConnection fcpConnection, ReceivedBookmarkFeed receivedBookmarkFeed);
+
+       /**
+        * Notifies a listener that a “ProtocolError” was received.
+        * 
+        * @param fcpConnection
+        *            The connection that received the message
         * @param protocolError
         *            The “ProtocolError” message
         */
@@ -386,7 +395,7 @@ public interface FcpListener extends EventListener {
         * Notifies a listener that a message has been received. This method is only
         * called if {@link FcpConnection#handleMessage(FcpMessage)} does not
         * recognize the message. Should that ever happen, please file a bug report!
-        *
+        * 
         * @param fcpConnection
         *            The connection that received the message
         * @param fcpMessage
@@ -398,7 +407,7 @@ public interface FcpListener extends EventListener {
         * Notifies a listener that a connection was closed. A closed connection can
         * be reestablished by calling {@link FcpConnection#connect()} on the same
         * object again.
-        *
+        * 
         * @param fcpConnection
         *            The connection that was closed.
         * @param throwable