✅ Add equals for AbstractState
[rhynodge.git] / src / main / java / net / pterodactylus / rhynodge / states / AbstractState.java
1 /*
2  * Rhynodge - AbstractState.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.states;
19
20 import java.time.Clock;
21 import java.util.Objects;
22 import javax.annotation.Nonnull;
23 import javax.annotation.Nullable;
24
25 import net.pterodactylus.rhynodge.Reaction;
26 import net.pterodactylus.rhynodge.State;
27 import net.pterodactylus.rhynodge.output.DefaultOutput;
28 import net.pterodactylus.rhynodge.output.Output;
29
30 import com.fasterxml.jackson.annotation.JsonProperty;
31 import com.fasterxml.jackson.annotation.JsonTypeInfo;
32 import com.google.common.escape.Escaper;
33 import com.google.common.html.HtmlEscapers;
34
35 /**
36  * Abstract implementation of a {@link State} that knows about the basic
37  * attributes of a {@link State}.
38  *
39  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
40  */
41 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
42 public abstract class AbstractState implements State {
43
44         /** The time of this state. */
45         @JsonProperty
46         private final long time;
47
48         /** Whether the state was successfully retrieved. */
49         private final boolean success;
50         private final boolean empty;
51
52         /** The optional exception that occured while retrieving the state. */
53         private final Throwable exception;
54
55         /** The number of consecutive failures. */
56         @JsonProperty
57         private int failCount;
58
59         /**
60          * Creates a new successful state.
61          */
62         protected AbstractState() {
63                 this(true);
64         }
65
66         /**
67          * Creates a new state.
68          *
69          * @param success
70          *            {@code true} if the state is successful, {@code false}
71          *            otherwise
72          */
73         protected AbstractState(boolean success) {
74                 this(Clock.systemUTC(), success);
75         }
76
77         /**
78          * Creates a new state.
79          *
80          * @param clock The clock for generating {@link #time}
81          * @param success {@code true} if the state is successful, {@code false}
82          *              otherwise
83          */
84         protected AbstractState(Clock clock, boolean success) {
85                 this(clock, success, true, null);
86         }
87
88         protected AbstractState(boolean success, boolean empty) {
89                 this(Clock.systemUTC(), success, empty);
90         }
91
92         protected AbstractState(Clock clock, boolean success, boolean empty) {
93                 this(clock, success, empty, null);
94         }
95
96         /**
97          * Creates a new non-successful state with the given exception.
98          *
99          * @param exception
100          *            The exception that occured while retrieving the state
101          */
102         protected AbstractState(Throwable exception) {
103                 this(Clock.systemUTC(), exception);
104         }
105
106         /**
107          * Creates a new non-successful state with the given exception.
108          *
109          * @param clock The clock for generating {@link #time}
110          * @param exception The exception that occured while retrieving the state
111          */
112         protected AbstractState(Clock clock, Throwable exception) {
113                 this(clock, false, true, exception);
114         }
115
116         /**
117          * Creates a new state.
118          *
119          * @param success
120          *            {@code true} if the state is successful, {@code false}
121          *            otherwise
122          * @param exception
123          *            The exception that occured while retrieving the state
124          */
125         protected AbstractState(boolean success, boolean empty, Throwable exception) {
126                 this(Clock.systemUTC(), success, empty, exception);
127         }
128
129         /**
130          * Creates a new state.
131          *
132          * @param clock The clock for generating {@link #time}
133          * @param success {@code true} if the state is successful, {@code false}
134          *              otherwise
135          * @param exception The exception that occured while retrieving the state
136          */
137         protected AbstractState(Clock clock, boolean success, boolean empty, Throwable exception) {
138                 this.time = clock.millis();
139                 this.success = success;
140                 this.empty = empty;
141                 this.exception = exception;
142         }
143
144         //
145         // STATE METHODS
146         //
147
148         /**
149          * {@inheritDoc}
150          */
151         @Override
152         public long time() {
153                 return time;
154         }
155
156         /**
157          * {@inheritDoc}
158          */
159         @Override
160         public boolean success() {
161                 return success;
162         }
163
164         @Override
165         public boolean isEmpty() {
166                 return empty;
167         }
168
169         /**
170          * {@inheritDoc}
171          */
172         @Override
173         public int failCount() {
174                 return failCount;
175         }
176
177         /**
178          * {@inheritDoc}
179          */
180         @Override
181         public void setFailCount(int failCount) {
182                 this.failCount = failCount;
183         }
184
185         /**
186          * {@inheritDoc}
187          */
188         @Override
189         public Throwable exception() {
190                 return exception;
191         }
192
193         @Nonnull
194         @Override
195         public Output output(Reaction reaction) {
196                 return new DefaultOutput(summary(reaction))
197                                 .addText("text/plain", plainText())
198                                 .addText("text/html", htmlText());
199         }
200
201         @Nonnull
202         protected String summary(Reaction reaction) {
203                 return reaction.name();
204         }
205
206         @Nonnull
207         protected abstract String plainText();
208
209         @Nullable
210         protected String htmlText() {
211                 //noinspection UnstableApiUsage
212                 return "<div>" + htmlEscaper.escape(plainText()) + "</div>";
213         }
214
215         @SuppressWarnings("UnstableApiUsage")
216         private static final Escaper htmlEscaper = HtmlEscapers.htmlEscaper();
217
218         @Override
219         public int hashCode() {
220                 return Objects.hash(success, empty, time, failCount, exception);
221         }
222
223         @Override
224         public boolean equals(Object object) {
225                 if (!(object instanceof AbstractState)) {
226                         return false;
227                 }
228                 AbstractState abstractState = (AbstractState) object;
229                 return (success == abstractState.success) && (empty == abstractState.empty) && (time == abstractState.time) && (failCount == abstractState.failCount) && Objects.equals(exception, abstractState.exception);
230         }
231
232 }