2 * Sone - SoneDatabase.java - Copyright © 2011 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.database;
20 import net.pterodactylus.sone.data.Sone;
23 * Interface for the Sone database.
25 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
27 public interface SoneDatabase {
30 * Returns the Sone with the given ID, creating a new Sone if a Sone with
31 * the given ID does not exist and {@code create} is {@code true}.
34 * The ID of the new Sone
36 * {@code true} to create a new Sone if a Sone with the given ID
37 * does not exist, {@code false} to return {@code null} if a Sone
38 * with the given ID does not exist
39 * @return The created Sone
40 * @throws IllegalArgumentException
41 * if {@code id} is {@code null}
42 * @throws DatabaseException
43 * if a database error occurs
45 public Sone getSone(String id, boolean create) throws DatabaseException;
48 * Stores the given Sone. The given Sone has to be an object that was
49 * returned by a previous call to {@link #getSone(String, boolean)}.
53 * @throws IllegalArgumentException
54 * if {@code sone} is {@code null}, or the Sone was not
55 * retrieved by a call to {@link #getSone(String, boolean)}
56 * @throws DatabaseException
57 * if a database error occurs
59 public void saveSone(Sone sone) throws DatabaseException;