2 * Sone - Album.java - Copyright © 2011–2016 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.data;
20 import static java.util.Arrays.asList;
21 import static java.util.Collections.emptyList;
23 import java.util.ArrayList;
24 import java.util.Collections;
25 import java.util.Comparator;
26 import java.util.List;
27 import javax.annotation.Nonnull;
29 import com.google.common.base.Function;
30 import com.google.common.base.Predicate;
31 import com.google.common.collect.FluentIterable;
32 import com.google.common.collect.ImmutableList;
35 * Container for images that can also contain nested {@link Album}s.
37 public interface Album extends Identified, Fingerprintable {
39 /** Compares two {@link Album}s by {@link #getTitle()}. */
40 Comparator<Album> TITLE_COMPARATOR = new Comparator<Album>() {
43 public int compare(Album leftAlbum, Album rightAlbum) {
44 return leftAlbum.getTitle().compareToIgnoreCase(rightAlbum.getTitle());
48 /** Function that flattens the given album and all albums beneath it. */
49 Function<Album, List<Album>> FLATTENER = new Function<Album, List<Album>>() {
53 public List<Album> apply(Album album) {
57 List<Album> albums = new ArrayList<Album>();
59 for (Album subAlbum : album.getAlbums()) {
60 albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList());
66 /** Function that transforms an album into the images it contains. */
67 Function<Album, List<Image>> IMAGES = new Function<Album, List<Image>>() {
71 public List<Image> apply(Album album) {
72 return (album != null) ? album.getImages() : Collections.<Image>emptyList();
77 * Filter that removes all albums that do not have any images in any album
80 Predicate<Album> NOT_EMPTY = new Predicate<Album>() {
83 public boolean apply(Album album) {
84 /* so, we flatten all albums below the given one and check whether at least one album… */
85 return FluentIterable.from(asList(album)).transformAndConcat(FLATTENER).anyMatch(new Predicate<Album>() {
88 public boolean apply(Album album) {
89 /* …contains any inserted images. */
90 return !album.getImages().isEmpty() && FluentIterable.from(album.getImages()).allMatch(new Predicate<Image>() {
93 public boolean apply(Image input) {
94 return input.isInserted();
103 * Returns the ID of this album.
105 * @return The ID of this album
110 * Returns the Sone this album belongs to.
112 * @return The Sone this album belongs to
117 * Returns the nested albums.
119 * @return The nested albums
121 List<Album> getAlbums();
124 * Adds an album to this album.
129 void addAlbum(Album album);
132 * Removes an album from this album.
135 * The album to remove
137 void removeAlbum(Album album);
140 * Moves the given album up in this album’s albums. If the album is already the
141 * first album, nothing happens.
144 * The album to move up
145 * @return The album that the given album swapped the place with, or
146 * <code>null</code> if the album did not change its place
148 Album moveAlbumUp(Album album);
151 * Moves the given album down in this album’s albums. If the album is already
152 * the last album, nothing happens.
155 * The album to move down
156 * @return The album that the given album swapped the place with, or
157 * <code>null</code> if the album did not change its place
159 Album moveAlbumDown(Album album);
162 * Returns the images in this album.
164 * @return The images in this album
166 List<Image> getImages();
169 * Adds the given image to this album.
174 void addImage(Image image);
177 * Removes the given image from this album.
180 * The image to remove
182 void removeImage(Image image);
185 * Moves the given image up in this album’s images. If the image is already the
186 * first image, nothing happens.
189 * The image to move up
190 * @return The image that the given image swapped the place with, or
191 * <code>null</code> if the image did not change its place
193 Image moveImageUp(Image image);
196 * Moves the given image down in this album’s images. If the image is already
197 * the last image, nothing happens.
200 * The image to move down
201 * @return The image that the given image swapped the place with, or
202 * <code>null</code> if the image did not change its place
204 Image moveImageDown(Image image);
207 * Returns whether this album contains any other albums or images.
209 * @return {@code true} if this album is empty, {@code false} otherwise
214 * Returns whether this album is an identitiy’s root album.
216 * @return {@code true} if this album is an identity’s root album, {@code
222 * Returns the parent album of this album.
224 * @return The parent album of this album, or {@code null} if this album does
230 * Sets the parent album of this album.
233 * The new parent album of this album
236 Album setParent(Album parent);
239 * Removes the parent album of this album.
243 Album removeParent();
246 * Returns the title of this album.
248 * @return The title of this album
253 * Returns the description of this album.
255 * @return The description of this album
257 String getDescription();
260 * Returns a modifier for this album.
262 * @return A modifier for this album
263 * @throws IllegalStateException
264 * if this album can not be modified
266 Modifier modify() throws IllegalStateException;
269 * Allows modifying an album. Modifications are only performed once {@link
270 * #update()} has succesfully returned a new album with the modifications
275 Modifier setTitle(String title);
277 Modifier setDescription(String description);
279 Album update() throws IllegalStateException;
281 class AlbumTitleMustNotBeEmpty extends IllegalStateException { }