♻️ Move output generation to state
[rhynodge.git] / src / main / java / net / pterodactylus / rhynodge / State.java
1 /*
2  * Rhynodge - State.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 javax.annotation.Nonnull;
21
22 import net.pterodactylus.rhynodge.output.Output;
23
24 /**
25  * Defines the current state of a system.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public interface State {
30
31         /**
32          * Returns the time when this state was retrieved.
33          *
34          * @return The time when this state was retrieved (in millseconds since Jan
35          *         1, 1970 UTC)
36          */
37         long time();
38
39         /**
40          * Whether the state was successfully retrieved. This method should only
41          * return {@code true} if a meaningful result could be retrieved; if e. g. a
42          * service is currently not reachable, this method should return false
43          * instead of emulating success by using empty lists or similar constructs.
44          *
45          * @return {@code true} if the state could be retrieved successfully,
46          *         {@code false} otherwise
47          */
48         boolean success();
49
50         boolean isEmpty();
51
52         /**
53          * Returns the number of consecutive failures. This method only returns a
54          * meaningful number iff {@link #success()} returns {@code false}. If
55          * {@link #success()} returns {@code false} for the first time after
56          * returning {@code true} and this method is called after {@link #success()}
57          * it will return {@code 1}.
58          *
59          * @return The number of consecutive failures
60          */
61         int failCount();
62
63         /**
64          * Sets the fail count of this state.
65          *
66          * @param failCount
67          *            The fail count of this state
68          */
69         void setFailCount(int failCount);
70
71         /**
72          * If {@link #success()} returns {@code false}, this method may return a
73          * {@link Throwable} to give some details for the reason why retrieving the
74          * state was not possible. For example, network-based {@link Query}s might
75          * return any exception that were encountered while communicating with the
76          * remote service.
77          *
78          * @return An exception that occured, may be {@code null} in case an
79          *         exception can not be meaningfully returned
80          */
81         Throwable exception();
82
83         @Nonnull
84         Output output(Reaction reaction);
85
86 }