/*
- * Sone - Album.java - Copyright © 2011–2013 David Roden
+ * Sone - Album.java - Copyright © 2011–2020 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
package net.pterodactylus.sone.data;
-import static java.util.Arrays.asList;
-import static java.util.Collections.emptyList;
-
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Comparator;
import java.util.List;
-import javax.annotation.Nonnull;
-
-import com.google.common.base.Function;
-import com.google.common.base.Predicate;
-import com.google.common.collect.FluentIterable;
-import com.google.common.collect.ImmutableList;
/**
* Container for images that can also contain nested {@link Album}s.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public interface Album extends Identified, Fingerprintable {
- /** Compares two {@link Album}s by {@link #getTitle()}. */
- Comparator<Album> TITLE_COMPARATOR = new Comparator<Album>() {
-
- @Override
- public int compare(Album leftAlbum, Album rightAlbum) {
- return leftAlbum.getTitle().compareToIgnoreCase(rightAlbum.getTitle());
- }
- };
-
- /** Function that flattens the given album and all albums beneath it. */
- Function<Album, List<Album>> FLATTENER = new Function<Album, List<Album>>() {
-
- @Override
- @Nonnull
- public List<Album> apply(Album album) {
- if (album == null) {
- return emptyList();
- }
- List<Album> albums = new ArrayList<Album>();
- albums.add(album);
- for (Album subAlbum : album.getAlbums()) {
- albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList());
- }
- return albums;
- }
- };
-
- /** Function that transforms an album into the images it contains. */
- Function<Album, List<Image>> IMAGES = new Function<Album, List<Image>>() {
-
- @Override
- @Nonnull
- public List<Image> apply(Album album) {
- return (album != null) ? album.getImages() : Collections.<Image>emptyList();
- }
- };
-
- /**
- * Filter that removes all albums that do not have any images in any album
- * below it.
- */
- Predicate<Album> NOT_EMPTY = new Predicate<Album>() {
-
- @Override
- public boolean apply(Album album) {
- /* so, we flatten all albums below the given one and check whether at least one album… */
- return FluentIterable.from(asList(album)).transformAndConcat(FLATTENER).anyMatch(new Predicate<Album>() {
-
- @Override
- public boolean apply(Album album) {
- /* …contains any inserted images. */
- return !album.getImages().isEmpty() && FluentIterable.from(album.getImages()).allMatch(new Predicate<Image>() {
-
- @Override
- public boolean apply(Image input) {
- return input.isInserted();
- }
- });
- }
- });
- }
- };
-
/**
* Returns the ID of this album.
*
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
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);
-
- /**
* Returns whether this album contains any other albums or images.
*
* @return {@code true} if this album is empty, {@code false} otherwise
String getTitle();
/**
- * Sets the title of this album.
- *
- * @param title
- * The title of this album
- * @return This album
- */
- Album setTitle(String title);
-
- /**
* Returns the description of this album.
*
* @return The description of this album
String getDescription();
/**
- * Sets the description of this album.
+ * Returns a modifier for this album.
*
- * @param description
- * The description of this album
- * @return This album
+ * @return A modifier for this album
+ * @throws IllegalStateException
+ * if this album can not be modified
+ */
+ Modifier modify() throws IllegalStateException;
+
+ /**
+ * Allows modifying an album. Modifications are only performed once {@link
+ * #update()} has succesfully returned a new album with the modifications
+ * made.
*/
- Album setDescription(String description);
+ interface Modifier {
+
+ Modifier setTitle(String title);
+
+ Modifier setDescription(String description);
+
+ Album update() throws IllegalStateException;
+
+ class AlbumTitleMustNotBeEmpty extends IllegalStateException { }
+
+ }
}
projects / Sone.git / blobdiff