import java.util.List;
import javax.annotation.Nonnull;
+import net.pterodactylus.sone.database.AlbumBuilder;
+import net.pterodactylus.sone.database.ImageBuilder;
+
import com.google.common.base.Function;
+import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import com.google.common.collect.FluentIterable;
import com.google.common.collect.ImmutableList;
*/
Sone getSone();
- /**
- * Sets the owner of the album. The owner can only be set as long as the
- * current owner is {@code null}.
- *
- * @param sone
- * The album owner
- * @return This album
- */
- Album setSone(Sone sone);
-
- /**
- * Returns the nested albums.
- *
- * @return The nested albums
- */
List<Album> getAlbums();
/**
- * Adds an album to this album.
- *
- * @param album
- * The album to add
- */
- void addAlbum(Album album);
-
- /**
- * Removes an album from this album.
- *
- * @param album
- * The album to remove
- */
- void removeAlbum(Album album);
-
- /**
- * Moves the given album up in this album’s albums. If the album is already the
- * first album, nothing happens.
- *
- * @param album
- * The album to move up
- * @return The album that the given album swapped the place with, or
- * <code>null</code> if the album did not change its place
- */
- Album moveAlbumUp(Album album);
-
- /**
- * Moves the given album down in this album’s albums. If the album is already
- * the last album, nothing happens.
- *
- * @param album
- * The album to move down
- * @return The album that the given album swapped the place with, or
- * <code>null</code> if the album did not change its place
- */
- Album moveAlbumDown(Album album);
-
- /**
* Returns the images in this album.
*
* @return The images in this album
*/
List<Image> getImages();
- /**
- * Adds the given image to this album.
- *
- * @param image
- * The image to add
- */
- void addImage(Image image);
-
- /**
- * Removes the given image from this album.
- *
- * @param image
- * The image to remove
- */
- void removeImage(Image image);
-
- /**
- * Moves the given image up in this album’s images. If the image is already the
- * first image, nothing happens.
- *
- * @param image
- * The image to move up
- * @return The image that the given image swapped the place with, or
- * <code>null</code> if the image did not change its place
- */
- Image moveImageUp(Image image);
-
- /**
- * Moves the given image down in this album’s images. If the image is already
- * the last image, nothing happens.
- *
- * @param image
- * The image to move down
- * @return The image that the given image swapped the place with, or
- * <code>null</code> if the image did not change its place
- */
- Image moveImageDown(Image image);
-
- /**
- * Returns the album image of this album, or {@code null} if no album image has
- * been set.
- *
- * @return The image to show when this album is listed
- */
- Image getAlbumImage();
-
- /**
- * Sets the ID of the album image.
- *
- * @param id
- * The ID of the album image
- * @return This album
- */
- Album setAlbumImage(String id);
+ Optional<Image> getAlbumImage();
/**
* Returns whether this album contains any other albums or images.
Album getParent();
/**
- * Sets the parent album of this album.
- *
- * @param parent
- * The new parent album of this album
- * @return This album
- */
- Album setParent(Album parent);
-
- /**
- * Removes the parent album of this album.
- *
- * @return This album
- */
- Album removeParent();
-
- /**
* Returns the title of this album.
*
* @return The title of this album
String getTitle();
/**
- * Sets the title of this album.
+ * Returns the description of this album.
*
- * @param title
- * The title of this album
- * @return This album
+ * @return The description of this album
*/
- Album setTitle(String title);
+ String getDescription();
+
+ AlbumBuilder newAlbumBuilder() throws IllegalStateException;
+
+ ImageBuilder newImageBuilder() throws IllegalStateException;
/**
- * Returns the description of this album.
+ * Returns a modifier for this album.
*
- * @return The description of this album
+ * @return A modifier for this album
+ * @throws IllegalStateException
+ * if this album can not be modified
*/
- String getDescription();
+ Modifier modify() throws IllegalStateException;
+
+ void moveUp();
+
+ void moveDown();
+
+ void remove() throws IllegalStateException;
/**
- * Sets the description of this album.
+ * Allows modifying an album. Modifications are only performed once {@link
+ * #update()} has succesfully returned a new album with the modifications
+ * made.
*
- * @param description
- * The description of this album
- * @return This album
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- Album setDescription(String description);
+ interface Modifier {
+
+ Modifier setTitle(String title);
+
+ Modifier setDescription(String description);
+
+ Modifier setAlbumImage(String imageId);
+
+ Album update() throws IllegalStateException;
+
+ }
}