🔀 Merge “work/next” into “next”
[Sone.git] / src / main / kotlin / net / pterodactylus / sone / database / PostReplyBuilder.kt
1 /*
2  * Sone - PostReplyBuilder.kt - Copyright Â© 2013–2020 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.database
19
20 import net.pterodactylus.sone.data.PostReply
21
22 /**
23  * Builder for a [PostReply] object.
24  */
25 interface PostReplyBuilder : ReplyBuilder<PostReplyBuilder> {
26
27         fun to(postId: String): PostReplyBuilder
28
29         /**
30          * Verifies the configuration of this builder and creates a new post reply.
31          *
32          * The following conditions must be met in order for the configuration to be
33          * considered valid:
34          *
35          *  * Exactly one of [randomId] or [withId] must have been called.
36          *  * The [sender][from] must not be `null`.
37          *  * Exactly one of [currentTime] or [withTime] must have been called.
38          *  * The [text][withText] must not be `null` and must contain something other than whitespace.
39          *  * The [post][to] must have been set.
40          *
41          * @return The created post reply
42          * @throws IllegalStateException if this builder’s configuration is not valid
43          */
44         fun build(): PostReply
45
46 }