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