Use a unique ID for posts
[Sone.git] / src / main / java / net / pterodactylus / sone / database / SoneProvider.java
1 /*
2  * Sone - SoneProvider.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.core.Core;
23 import net.pterodactylus.sone.data.Sone;
24
25 import com.google.common.base.Function;
26 import com.google.common.base.Optional;
27 import com.google.inject.ImplementedBy;
28
29 /**
30  * Interface for objects that can provide {@link Sone}s by their ID.
31  *
32  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33  */
34 @ImplementedBy(Core.class)
35 public interface SoneProvider {
36
37         Function<String, Optional<Sone>> soneLoader();
38
39         /**
40          * Returns the Sone with the given ID, or {@link Optional#absent()} if it
41          * does not exist.
42          *
43          * @param soneId
44          *            The ID of the Sone to return
45          * @return The Sone with the given ID, or {@link Optional#absent()}
46          */
47         public Optional<Sone> getSone(String soneId);
48
49         /**
50          * Returns all Sones.
51          *
52          * @return All Sones
53          */
54         public Collection<Sone> getSones();
55
56         /**
57          * Returns all local Sones.
58          *
59          * @return All local Sones
60          */
61         public Collection<Sone> getLocalSones();
62
63         /**
64          * Returns all remote Sones.
65          *
66          * @return All remote Sones
67          */
68         public Collection<Sone> getRemoteSones();
69
70 }