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

   1 /*
   2  * Sone - AlbumBuilder.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 import net.pterodactylus.sone.data.Sone;
  22
  23 /**
  24  * Builder for {@link Album} objects.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public interface AlbumBuilder {
  29
  30         /**
  31          * Configures this builder to create an album with a random ID.
  32          *
  33          * @return This album builder
  34          */
  35         AlbumBuilder randomId();
  36
  37         /**
  38          * Configures this builder to create an album with the given ID.
  39          *
  40          * @param id
  41          *              The ID of the album
  42          * @return This album builder
  43          */
  44         AlbumBuilder withId(String id);
  45
  46         AlbumBuilder by(Sone sone);
  47
  48         /**
  49          * Creates the album.
  50          *
  51          * @return The created album
  52          * @throws IllegalStateException
  53          *              if the album could not be created
  54          */
  55         Album build() throws IllegalStateException;
  56
  57 }