Add Pirate Bay watcher for “normal” files.
[rhynodge.git] / src / main / java / net / pterodactylus / rhynodge / package-info.java
1 /**
2  * Rhynodge main definitions.
3  * <p>
4  * A {@link net.pterodactylus.rhynodge.Reaction} consists of three different
5  * elements: a {@link net.pterodactylus.rhynodge.Query}, a
6  * {@link net.pterodactylus.rhynodge.Trigger}, and an
7  * {@link net.pterodactylus.rhynodge.Action}.
8  * <p>
9  * A {@code Query} retrieves the current state of a system; this can simply be
10  * the current state of a local file, or it can be the last tweet of a certain
11  * Twitter account, or it can be anything inbetween, or something completely
12  * different.
13  * <p>
14  * After a {@code Query} retrieved the current
15  * {@link net.pterodactylus.rhynodge.State} of a system, this state and the
16  * previously retrieved state are handed in to a {@code Trigger}. The trigger
17  * then decides whether the state of the system can be considered a change.
18  * <p>
19  * If a system has been found to trigger, an {@code Action} is executed. It
20  * performs arbitrary actions and can use both the current state and the
21  * previous state to define that action.
22  */
23
24 package net.pterodactylus.rhynodge;
25