/*
- * Sone - Album.java - Copyright © 2011–2015 David Roden
+ * Sone - Album.java - Copyright © 2011–2019 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
import java.util.ArrayList;
import java.util.Collections;
-import java.util.Comparator;
import java.util.List;
import javax.annotation.Nonnull;
/**
* 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>>() {
if (album == null) {
return emptyList();
}
- List<Album> albums = new ArrayList<Album>();
+ List<Album> albums = new ArrayList<>();
albums.add(album);
for (Album subAlbum : album.getAlbums()) {
albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList());
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();
-
- /**
* Returns whether this album contains any other albums or images.
*
* @return {@code true} if this album is empty, {@code false} otherwise
* Allows modifying an album. Modifications are only performed once {@link
* #update()} has succesfully returned a new album with the modifications
* made.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
interface Modifier {
Modifier setDescription(String description);
- Modifier setAlbumImage(String imageId);
-
Album update() throws IllegalStateException;
class AlbumTitleMustNotBeEmpty extends IllegalStateException { }