Add filter interface.
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Thu, 14 Mar 2013 18:54:34 +0000 (19:54 +0100)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Thu, 14 Mar 2013 18:54:34 +0000 (19:54 +0100)
src/main/java/net/pterodactylus/sonitus/data/Filter.java [new file with mode: 0644]

diff --git a/src/main/java/net/pterodactylus/sonitus/data/Filter.java b/src/main/java/net/pterodactylus/sonitus/data/Filter.java
new file mode 100644 (file)
index 0000000..94c986c
--- /dev/null
@@ -0,0 +1,47 @@
+/*
+ * Sonitus - Filter.java - Copyright © 2013 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.sonitus.data;
+
+/**
+ * A filter processes an input to produce an output.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface Filter {
+
+       /**
+        * Returns whether this filter understands the given format.
+        *
+        * @param format
+        *              The format to check for
+        * @return {@code true} if this filter understands the given format, {@code
+        *         false} otherwise
+        */
+       boolean understands(Format format);
+
+       /**
+        * Returns whether this filter can produce the given format.
+        *
+        * @param format
+        *              The format to check for
+        * @return {@code true} if this filter can produce the given format, {@code
+        *         false} otherwise
+        */
+       boolean produces(Format format);
+
+}