React to dedicated exception differently
[Sone.git] / src / main / java / net / pterodactylus / sone / database / PostProvider.java
1 /*
2  * Sone - PostProvider.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.database;
19
20 import java.util.Collection;
21
22 import net.pterodactylus.sone.data.Post;
23 import net.pterodactylus.sone.database.memory.MemoryDatabase;
24
25 import com.google.common.base.Optional;
26 import com.google.inject.ImplementedBy;
27
28 /**
29  * Interface for objects that can provide {@link Post}s by their ID.
30  *
31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
32  */
33 @ImplementedBy(MemoryDatabase.class)
34 public interface PostProvider {
35
36         /**
37          * Returns the post with the given ID.
38          *
39          * @param postId
40          *            The ID of the post to return
41          * @return The post with the given ID, or {@code null}
42          */
43         public Optional<Post> getPost(String postId);
44
45         /**
46          * Returns all posts from the given Sone.
47          *
48          * @param soneId
49          *            The ID of the Sone
50          * @return All posts from the given Sone
51          */
52         public Collection<Post> getPosts(String soneId);
53
54         /**
55          * Returns all posts that have the given Sone as recipient.
56          *
57          * @see Post#getRecipient()
58          * @param recipientId
59          *            The ID of the recipient of the posts
60          * @return All posts that have the given Sone as recipient
61          */
62         public Collection<Post> getDirectedPosts(String recipientId);
63
64 }