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