Abbreviate excerpts on the last space.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / PostProvider.java
1 /*
2  * Sone - PostProvider.java - Copyright © 2011–2012 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.core;
19
20 import net.pterodactylus.sone.data.Post;
21
22 /**
23  * Interface for objects that can provide {@link Post}s by their ID.
24  *
25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
26  */
27 public interface PostProvider {
28
29         /**
30          * Returns the post with the given ID, if it exists. If it does not exist
31          * and {@code create} is {@code false}, {@code null} is returned; otherwise,
32          * a new post with the given ID is created and returned.
33          *
34          * @param postId
35          *            The ID of the post to return
36          * @param create
37          *            {@code true} to create a new post if no post with the given ID
38          *            exists, {@code false} to return {@code null} instead
39          * @return The post with the given ID, or {@code null}
40          */
41         public Post getPost(String postId, boolean create);
42
43 }