src/main/java/net/pterodactylus/sone/database/AlbumProvider.java

   1 /*
   2  * Sone - AlbumProvider.java - Copyright © 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 net.pterodactylus.sone.data.Album;
  21
  22 import com.google.common.base.Optional;
  23
  24 /**
  25  * Interface for objects that can provide {@link Album}s by their ID.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public interface AlbumProvider {
  30
  31         /**
  32          * Returns the album with the given ID, or {@link Optional#absent()} if no such
  33          * album exists.
  34          *
  35          * @param albumId
  36          *              The ID of the album
  37          * @return The album, or {@link Optional#absent()} if the album does not exist
  38          */
  39         Optional<Album> getAlbum(String albumId);
  40
  41 }