From 367edf1b6da27a73e1f822d7087a3a764ebff3e8 Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Thu, 14 Mar 2013 19:54:34 +0100 Subject: [PATCH] Add filter interface. --- .../net/pterodactylus/sonitus/data/Filter.java | 47 ++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 src/main/java/net/pterodactylus/sonitus/data/Filter.java 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 index 0000000..94c986c --- /dev/null +++ b/src/main/java/net/pterodactylus/sonitus/data/Filter.java @@ -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 . + */ + +package net.pterodactylus.sonitus.data; + +/** + * A filter processes an input to produce an output. + * + * @author David ‘Bombe’ Roden + */ +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); + +} -- 2.7.4