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