From: David ‘Bombe’ Roden Date: Tue, 15 Jan 2013 08:58:08 +0000 (+0100) Subject: Add post reply provider interface. X-Git-Tag: 0.8.5^2~3^2~143 X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=729754c92273a07c31137d3740e2657bad10a898;p=Sone.git Add post reply provider interface. --- diff --git a/src/main/java/net/pterodactylus/sone/core/PostReplyProvider.java b/src/main/java/net/pterodactylus/sone/core/PostReplyProvider.java new file mode 100644 index 0000000..ddf3317 --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/core/PostReplyProvider.java @@ -0,0 +1,44 @@ +/* + * Sone - PostReplyProvider.java - Copyright © 2013 David Roden + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.core; + +import net.pterodactylus.sone.data.PostReply; + +/** + * Interface for objects that can provide {@link PostReply}s by their ID. + * + * @author David ‘Bombe’ Roden + */ +public interface PostReplyProvider { + + /** + * Returns the post reply with the given ID, if it exists. If it does not + * exist and {@code create} is {@code false}, {@code null} is returned; + * otherwise, a new post reply with the given ID is created and returned. + * + * @param replyId + * The ID of the post reply to return + * @param create + * {@code true} to create a new post reply if no post reply with + * the given ID exists, {@code false} to return {@code null} + * instead + * @return The post reply with the given ID, or {@code null} + */ + public PostReply getPostReply(String replyId, boolean create); + +}