Enhance trigger interface to allow merging states.
[rhynodge.git] / src / main / java / net / pterodactylus / rhynodge / triggers / AlwaysTrigger.java
1 /*
2  * Rhynodge - AlwaysTrigger.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.triggers;
19
20 import net.pterodactylus.rhynodge.Reaction;
21 import net.pterodactylus.rhynodge.State;
22 import net.pterodactylus.rhynodge.Trigger;
23 import net.pterodactylus.rhynodge.output.DefaultOutput;
24 import net.pterodactylus.rhynodge.output.Output;
25
26 /**
27  * {@link Trigger} implementation that always triggers.
28  *
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public class AlwaysTrigger implements Trigger {
32
33         /**
34          * {@inheritDoc}
35          * <p>
36          * This implementation returns the current state.
37          */
38         @Override
39         public State mergeStates(State previousState, State currentState) {
40                 return currentState;
41         }
42
43         /**
44          * {@inheritDoc}
45          * <p>
46          * This implementation always returns {@code true}.
47          */
48         @Override
49         public boolean triggers() {
50                 return true;
51         }
52
53         /**
54          * {@inheritDoc}
55          */
56         @Override
57         public Output output(Reaction reaction) {
58                 return new DefaultOutput("true").addText("text/plain", "true").addText("text/html", "<div>true</div>");
59         }
60
61 }