From: David ‘Bombe’ Roden Date: Thu, 9 Jun 2011 08:35:51 +0000 (+0200) Subject: Add interfaces for Sone and post providers. X-Git-Tag: 0.6.5^2~8^2~11 X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=14b7691e9722d0b565531d1fba6cc70963c06a65;p=Sone.git Add interfaces for Sone and post providers. --- diff --git a/src/main/java/net/pterodactylus/sone/core/PostProvider.java b/src/main/java/net/pterodactylus/sone/core/PostProvider.java new file mode 100644 index 0000000..edede44 --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/core/PostProvider.java @@ -0,0 +1,43 @@ +/* + * Sone - PostProvider.java - Copyright © 2011 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.Post; + +/** + * Interface for objects that can provide {@link Post}s by their ID. + * + * @author David ‘Bombe’ Roden + */ +public interface PostProvider { + + /** + * Returns the post 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 with the given ID is created and returned. + * + * @param postId + * The ID of the post to return + * @param create + * {@code true} to create a new post if no post with the given ID + * exists, {@code false} to return {@code null} instead + * @return The post with the given ID, or {@code null} + */ + public Post getPost(String postId, boolean create); + +} diff --git a/src/main/java/net/pterodactylus/sone/core/SoneProvider.java b/src/main/java/net/pterodactylus/sone/core/SoneProvider.java new file mode 100644 index 0000000..dcf0f61 --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/core/SoneProvider.java @@ -0,0 +1,43 @@ +/* + * Sone - SoneProvider.java - Copyright © 2011 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.Sone; + +/** + * Interface for objects that can provide {@link Sone}s by their ID. + * + * @author David ‘Bombe’ Roden + */ +public interface SoneProvider { + + /** + * Returns the Sone 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 Sone with the given ID is created and returned. + * + * @param soneId + * The ID of the Sone to return + * @param create + * {@code true} to create a new Sone if no Sone with the given ID + * exists, {@code false} to return {@code null} instead + * @return The Sone with the given ID, or {@code null} + */ + public Sone getSone(String soneId, boolean create); + +}