Return an optional from the Core already.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / impl / ReplyImpl.java
1 /*
2  * Sone - ReplyImpl.java - Copyright © 2011–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.sone.data.impl;
19
20 import net.pterodactylus.sone.data.Reply;
21 import net.pterodactylus.sone.data.Sone;
22 import net.pterodactylus.sone.database.Database;
23
24 /**
25  * Abstract base class for all replies.
26  *
27  * @param <T>
28  *              The type of the reply
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public abstract class ReplyImpl<T extends Reply<T>> implements Reply<T> {
32
33         protected final Database database;
34
35         /** The ID of the reply. */
36         private final String id;
37
38         /** The Sone that created this reply. */
39         private final String soneId;
40
41         /** The time of the reply. */
42         private final long time;
43
44         /** The text of the reply. */
45         private final String text;
46
47         /** Whether the reply is known. */
48         private volatile boolean known;
49
50         /**
51          * Creates a new reply.
52          *
53          * @param database
54          *              The database
55          * @param id
56          *              The ID of the reply
57          * @param soneId
58          *              The ID of the Sone of the reply
59          * @param time
60          *              The time of the reply
61          * @param text
62          */
63         protected ReplyImpl(Database database, String id, String soneId, long time, String text) {
64                 this.database = database;
65                 this.id = id;
66                 this.soneId = soneId;
67                 this.time = time;
68                 this.text = text;
69         }
70
71         /** {@inheritDoc} */
72         @Override
73         public String getId() {
74                 return id;
75         }
76
77         /** {@inheritDoc} */
78         @Override
79         public Sone getSone() {
80                 return database.getSone(soneId).get();
81         }
82
83         /** {@inheritDoc} */
84         @Override
85         public long getTime() {
86                 return time;
87         }
88
89         /** {@inheritDoc} */
90         @Override
91         public String getText() {
92                 return text;
93         }
94
95         /** {@inheritDoc} */
96         @Override
97         public boolean isKnown() {
98                 return known;
99         }
100
101         /** {@inheritDoc} */
102         @Override
103         @SuppressWarnings("unchecked")
104         public T setKnown(boolean known) {
105                 this.known = known;
106                 return (T) this;
107         }
108
109         //
110         // OBJECT METHODS
111         //
112
113         /** {@inheritDoc} */
114         @Override
115         public int hashCode() {
116                 return id.hashCode();
117         }
118
119         /** {@inheritDoc} */
120         @Override
121         public boolean equals(Object object) {
122                 if (!(object instanceof Reply<?>)) {
123                         return false;
124                 }
125                 Reply<?> reply = (Reply<?>) object;
126                 return reply.getId().equals(id);
127         }
128
129         /** {@inheritDoc} */
130         @Override
131         public String toString() {
132                 return String.format("%s[id=%s,sone=%s,time=%d,text=%s]", getClass().getName(), id, soneId, time, text);
133         }
134
135 }