2 * Sone - SoneProvider.java - Copyright © 2011–2016 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 java.util.Collection;
22 import javax.annotation.Nonnull;
24 import net.pterodactylus.sone.core.Core;
25 import net.pterodactylus.sone.data.Sone;
27 import com.google.common.base.Function;
28 import com.google.common.base.Optional;
29 import com.google.inject.ImplementedBy;
32 * Interface for objects that can provide {@link Sone}s by their ID.
34 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
36 @ImplementedBy(Core.class)
37 public interface SoneProvider {
39 Function<String, Optional<Sone>> soneLoader();
42 * Returns the Sone with the given ID, or {@link Optional#absent()} if it
46 * The ID of the Sone to return
47 * @return The Sone with the given ID, or {@link Optional#absent()}
49 public Optional<Sone> getSone(String soneId);
57 public Collection<Sone> getSones();
60 * Returns all local Sones.
62 * @return All local Sones
64 public Collection<Sone> getLocalSones();
67 * Returns all remote Sones.
69 * @return All remote Sones
71 public Collection<Sone> getRemoteSones();