/* * Sone - AlbumBuilder.java - Copyright © 2013–2016 David Roden * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ package net.pterodactylus.sone.database; import net.pterodactylus.sone.data.Album; import net.pterodactylus.sone.data.Sone; /** * Builder for {@link Album} objects. * * @author David ‘Bombe’ Roden */ public interface AlbumBuilder { /** * Configures this builder to create an album with a random ID. * * @return This album builder */ AlbumBuilder randomId(); /** * Configures this builder to create an album with the given ID. * * @param id * The ID of the album * @return This album builder */ AlbumBuilder withId(String id); AlbumBuilder by(Sone sone); /** * Creates the album. * * @return The created album * @throws IllegalStateException * if the album could not be created */ Album build() throws IllegalStateException; }