Add Pirate Bay watcher for “normal” files.
[rhynodge.git] / src / main / java / net / pterodactylus / rhynodge / Watcher.java
1 /*
2  * Rhynodge - Watcher.java - Copyright © 2013 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.rhynodge;
19
20 import java.util.List;
21
22 /**
23  * A {@code Watcher} combines a {@link Query}, a number of {@link Filter}s, and
24  * a {@link Trigger}, as these parts are closely related after all.
25  *
26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
27  */
28 public interface Watcher {
29
30         /**
31          * Returns the query of the watcher.
32          *
33          * @return The query of the watcher
34          */
35         public Query query();
36
37         /**
38          * Returns the filters of the watcher.
39          *
40          * @return The filters of the watcher
41          */
42         public List<Filter> filters();
43
44         /**
45          * Returns the trigger of the watcher.
46          *
47          * @return The trigger of the watcher
48          */
49         public Trigger trigger();
50
51 }