Add interface to mark all FCP messages that have an “Identifier” field.
authorDavid ‘Bombe’ Roden <bombe@freenetproject.org>
Thu, 15 Apr 2010 09:09:52 +0000 (11:09 +0200)
committerDavid ‘Bombe’ Roden <bombe@freenetproject.org>
Thu, 15 Apr 2010 09:09:52 +0000 (11:09 +0200)
src/main/java/net/pterodactylus/fcp/Identifiable.java [new file with mode: 0644]

diff --git a/src/main/java/net/pterodactylus/fcp/Identifiable.java b/src/main/java/net/pterodactylus/fcp/Identifiable.java
new file mode 100644 (file)
index 0000000..b206209
--- /dev/null
@@ -0,0 +1,34 @@
+/*
+ * jFCPlib - Identifiable.java - Copyright © 2010 David Roden
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.fcp;
+
+/**
+ * Interface for all {@link FcpMessage}s that have an “Identifier” field.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface Identifiable {
+
+       /**
+        * Returns the identifier of the FCP message.
+        *
+        * @return The identifier of the FCP message
+        */
+       public String getIdentifier();
+
+}