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 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
39 public interface Album extends Identified, Fingerprintable {
41 /** Compares two {@link Album}s by {@link #getTitle()}. */
42 Comparator<Album> TITLE_COMPARATOR = new Comparator<Album>() {
45 public int compare(Album leftAlbum, Album rightAlbum) {
46 return leftAlbum.getTitle().compareToIgnoreCase(rightAlbum.getTitle());
50 /** Function that flattens the given album and all albums beneath it. */
51 Function<Album, List<Album>> FLATTENER = new Function<Album, List<Album>>() {
55 public List<Album> apply(Album album) {
59 List<Album> albums = new ArrayList<Album>();
61 for (Album subAlbum : album.getAlbums()) {
62 albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList());
68 /** Function that transforms an album into the images it contains. */
69 Function<Album, List<Image>> IMAGES = new Function<Album, List<Image>>() {
73 public List<Image> apply(Album album) {
74 return (album != null) ? album.getImages() : Collections.<Image>emptyList();
79 * Filter that removes all albums that do not have any images in any album
82 Predicate<Album> NOT_EMPTY = new Predicate<Album>() {
85 public boolean apply(Album album) {
86 /* so, we flatten all albums below the given one and check whether at least one album… */
87 return FluentIterable.from(asList(album)).transformAndConcat(FLATTENER).anyMatch(new Predicate<Album>() {
90 public boolean apply(Album album) {
91 /* …contains any inserted images. */
92 return !album.getImages().isEmpty() && FluentIterable.from(album.getImages()).allMatch(new Predicate<Image>() {
95 public boolean apply(Image input) {
96 return input.isInserted();
105 * Returns the ID of this album.
107 * @return The ID of this album
112 * Returns the Sone this album belongs to.
114 * @return The Sone this album belongs to
119 * Returns the nested albums.
121 * @return The nested albums
123 List<Album> getAlbums();
126 * Adds an album to this album.
131 void addAlbum(Album album);
134 * Removes an album from this album.
137 * The album to remove
139 void removeAlbum(Album album);
142 * Moves the given album up in this album’s albums. If the album is already the
143 * first album, nothing happens.
146 * The album to move up
147 * @return The album that the given album swapped the place with, or
148 * <code>null</code> if the album did not change its place
150 Album moveAlbumUp(Album album);
153 * Moves the given album down in this album’s albums. If the album is already
154 * the last album, nothing happens.
157 * The album to move down
158 * @return The album that the given album swapped the place with, or
159 * <code>null</code> if the album did not change its place
161 Album moveAlbumDown(Album album);
164 * Returns the images in this album.
166 * @return The images in this album
168 List<Image> getImages();
171 * Adds the given image to this album.
176 void addImage(Image image);
179 * Removes the given image from this album.
182 * The image to remove
184 void removeImage(Image image);
187 * Moves the given image up in this album’s images. If the image is already the
188 * first image, nothing happens.
191 * The image to move up
192 * @return The image that the given image swapped the place with, or
193 * <code>null</code> if the image did not change its place
195 Image moveImageUp(Image image);
198 * Moves the given image down in this album’s images. If the image is already
199 * the last image, nothing happens.
202 * The image to move down
203 * @return The image that the given image swapped the place with, or
204 * <code>null</code> if the image did not change its place
206 Image moveImageDown(Image image);
209 * Returns whether this album contains any other albums or images.
211 * @return {@code true} if this album is empty, {@code false} otherwise
216 * Returns whether this album is an identitiy’s root album.
218 * @return {@code true} if this album is an identity’s root album, {@code
224 * Returns the parent album of this album.
226 * @return The parent album of this album, or {@code null} if this album does
232 * Sets the parent album of this album.
235 * The new parent album of this album
238 Album setParent(Album parent);
241 * Removes the parent album of this album.
245 Album removeParent();
248 * Returns the title of this album.
250 * @return The title of this album
255 * Returns the description of this album.
257 * @return The description of this album
259 String getDescription();
262 * Returns a modifier for this album.
264 * @return A modifier for this album
265 * @throws IllegalStateException
266 * if this album can not be modified
268 Modifier modify() throws IllegalStateException;
271 * Allows modifying an album. Modifications are only performed once {@link
272 * #update()} has succesfully returned a new album with the modifications
275 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
279 Modifier setTitle(String title);
281 Modifier setDescription(String description);
283 Album update() throws IllegalStateException;
285 class AlbumTitleMustNotBeEmpty extends IllegalStateException { }