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