X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FAlbum.java;h=f90a42f3b02a9154afe52b15012436bcc6f50b32;hp=0bdf3a9eb3e66c60b184f9f4e099d170f0053be6;hb=f5fc7fdf598e1a10757069e0701c41a86047d266;hpb=ba4811ca5360e93b449629132b4c6583aa82eb1a diff --git a/src/main/java/net/pterodactylus/sone/data/Album.java b/src/main/java/net/pterodactylus/sone/data/Album.java index 0bdf3a9..f90a42f 100644 --- a/src/main/java/net/pterodactylus/sone/data/Album.java +++ b/src/main/java/net/pterodactylus/sone/data/Album.java @@ -1,5 +1,5 @@ /* - * Sone - Album.java - Copyright © 2011 David Roden + * Sone - Album.java - Copyright © 2011–2016 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 @@ -17,458 +17,259 @@ package net.pterodactylus.sone.data; +import static java.util.Arrays.asList; +import static java.util.Collections.emptyList; + import java.util.ArrayList; -import java.util.Comparator; -import java.util.HashMap; +import java.util.Collections; import java.util.List; -import java.util.Map; -import java.util.UUID; +import javax.annotation.Nonnull; -import net.pterodactylus.util.collection.Mapper; -import net.pterodactylus.util.collection.Mappers; -import net.pterodactylus.util.object.Default; -import net.pterodactylus.util.validation.Validation; +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 David ‘Bombe’ Roden */ -public class Album implements Fingerprintable { +public interface Album extends Identified, Fingerprintable { - /** Compares two {@link Album}s by {@link #getTitle()}. */ - public static final Comparator TITLE_COMPARATOR = new Comparator() { + /** Function that flattens the given album and all albums beneath it. */ + Function> FLATTENER = new Function>() { @Override - public int compare(Album leftAlbum, Album rightAlbum) { - return leftAlbum.getTitle().compareToIgnoreCase(rightAlbum.getTitle()); + @Nonnull + public List apply(Album album) { + if (album == null) { + return emptyList(); + } + List albums = new ArrayList(); + albums.add(album); + for (Album subAlbum : album.getAlbums()) { + albums.addAll(FluentIterable.from(ImmutableList.of(subAlbum)).transformAndConcat(FLATTENER).toList()); + } + return albums; } }; - /** The ID of this album. */ - private final String id; - - /** The Sone this album belongs to. */ - private Sone sone; - - /** Nested albums. */ - private final List albums = new ArrayList(); - - /** The image IDs in order. */ - private final List imageIds = new ArrayList(); - - /** The images in this album. */ - private final Map images = new HashMap(); - - /** The parent album. */ - private Album parent; - - /** The title of this album. */ - private String title; - - /** The description of this album. */ - private String description; + /** Function that transforms an album into the images it contains. */ + Function> IMAGES = new Function>() { - /** The ID of the album picture. */ - private String albumImage; - - /** - * Creates a new album with a random ID. - */ - public Album() { - this(UUID.randomUUID().toString()); - } + @Override + @Nonnull + public List apply(Album album) { + return (album != null) ? album.getImages() : Collections.emptyList(); + } + }; /** - * Creates a new album with the given ID. - * - * @param id - * The ID of the album + * Filter that removes all albums that do not have any images in any album + * below it. */ - public Album(String id) { - Validation.begin().isNotNull("Album ID", id).check(); - this.id = id; - } + Predicate NOT_EMPTY = new Predicate() { - // - // ACCESSORS - // + @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() { + + @Override + public boolean apply(Album album) { + /* …contains any inserted images. */ + return !album.getImages().isEmpty() && FluentIterable.from(album.getImages()).allMatch(new Predicate() { + + @Override + public boolean apply(Image input) { + return input.isInserted(); + } + }); + } + }); + } + }; /** * Returns the ID of this album. * * @return The ID of this album */ - public String getId() { - return id; - } + String getId(); /** * Returns the Sone this album belongs to. * * @return The Sone this album belongs to */ - public Sone getSone() { - return sone; - } - - /** - * 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 - */ - public Album setSone(Sone sone) { - Validation.begin().isNotNull("New Album Owner", sone).isEither("Old Album Owner", this.sone, null, sone).check(); - this.sone = sone; - return this; - } + Sone getSone(); /** * Returns the nested albums. * * @return The nested albums */ - public List getAlbums() { - return new ArrayList(albums); - } + List getAlbums(); /** * Adds an album to this album. * * @param album - * The album to add + * The album to add */ - public void addAlbum(Album album) { - Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isEither("Old Album Parent", this.parent, null, album.parent).check(); - album.setParent(this); - if (!albums.contains(album)) { - albums.add(album); - } - } + void addAlbum(Album album); /** * Removes an album from this album. * * @param album - * The album to remove + * The album to remove */ - public void removeAlbum(Album album) { - Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isEqual("Album Parent", album.parent, this).check(); - albums.remove(album); - album.removeParent(); - } + void removeAlbum(Album album); /** - * Moves the given album up in this album’s albums. If the album is already - * the first album, nothing happens. + * 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 + * The album to move up * @return The album that the given album swapped the place with, or * null if the album did not change its place */ - public Album moveAlbumUp(Album album) { - Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isEqual("Album Parent", album.parent, this).check(); - int oldIndex = albums.indexOf(album); - if (oldIndex <= 0) { - return null; - } - albums.remove(oldIndex); - albums.add(oldIndex - 1, album); - return albums.get(oldIndex); - } + Album moveAlbumUp(Album album); /** - * Moves the given album down in this album’s albums. If the album is - * already the last album, nothing happens. + * 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 + * The album to move down * @return The album that the given album swapped the place with, or * null if the album did not change its place */ - public Album moveAlbumDown(Album album) { - Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isEqual("Album Parent", album.parent, this).check(); - int oldIndex = albums.indexOf(album); - if ((oldIndex < 0) || (oldIndex >= (albums.size() - 1))) { - return null; - } - albums.remove(oldIndex); - albums.add(oldIndex + 1, album); - return albums.get(oldIndex); - } + Album moveAlbumDown(Album album); /** * Returns the images in this album. * * @return The images in this album */ - public List getImages() { - return Mappers.mappedList(imageIds, new Mapper() { - - @Override - @SuppressWarnings("synthetic-access") - public Image map(String imageId) { - return images.get(imageId); - } - - }); - } + List getImages(); /** * Adds the given image to this album. * * @param image - * The image to add + * The image to add */ - public void addImage(Image image) { - Validation.begin().isNotNull("Image", image).check().isNotNull("Image Owner", image.getSone()).check().isEqual("Image Owner", image.getSone(), sone).check(); - if (image.getAlbum() != null) { - image.getAlbum().removeImage(image); - } - image.setAlbum(this); - if (imageIds.isEmpty() && (albumImage == null)) { - albumImage = image.getId(); - } - if (!imageIds.contains(image.getId())) { - imageIds.add(image.getId()); - images.put(image.getId(), image); - } - } + void addImage(Image image); /** * Removes the given image from this album. * * @param image - * The image to remove + * The image to remove */ - public void removeImage(Image image) { - Validation.begin().isNotNull("Image", image).check().isEqual("Image Owner", image.getSone(), sone).check(); - imageIds.remove(image.getId()); - images.remove(image.getId()); - if (image.getId().equals(albumImage)) { - if (images.isEmpty()) { - albumImage = null; - } else { - albumImage = images.values().iterator().next().getId(); - } - } - } + void removeImage(Image image); /** - * Moves the given image up in this album’s images. If the image is already - * the first image, nothing happens. + * 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 + * The image to move up * @return The image that the given image swapped the place with, or * null if the image did not change its place */ - public Image moveImageUp(Image image) { - Validation.begin().isNotNull("Image", image).check().isEqual("Image Album", image.getAlbum(), this).isEqual("Album Owner", image.getAlbum().getSone(), sone).check(); - int oldIndex = imageIds.indexOf(image.getId()); - if (oldIndex <= 0) { - return null; - } - imageIds.remove(image.getId()); - imageIds.add(oldIndex - 1, image.getId()); - return images.get(imageIds.get(oldIndex)); - } + Image moveImageUp(Image image); /** - * Moves the given image down in this album’s images. If the image is - * already the last image, nothing happens. + * 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 + * The image to move down * @return The image that the given image swapped the place with, or * null if the image did not change its place */ - public Image moveImageDown(Image image) { - Validation.begin().isNotNull("Image", image).check().isEqual("Image Album", image.getAlbum(), this).isEqual("Album Owner", image.getAlbum().getSone(), sone).check(); - int oldIndex = imageIds.indexOf(image.getId()); - if ((oldIndex == -1) || (oldIndex >= (imageIds.size() - 1))) { - return null; - } - imageIds.remove(image.getId()); - imageIds.add(oldIndex + 1, image.getId()); - return images.get(imageIds.get(oldIndex)); - } - - /** - * 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 - */ - public Image getAlbumImage() { - if (albumImage == null) { - return null; - } - return Default.forNull(images.get(albumImage), images.values().iterator().next()); - } + Image moveImageDown(Image image); /** - * Sets the ID of the album image. + * Returns whether this album contains any other albums or images. * - * @param id - * The ID of the album image - * @return This album + * @return {@code true} if this album is empty, {@code false} otherwise */ - public Album setAlbumImage(String id) { - this.albumImage = id; - return this; - } + boolean isEmpty(); /** - * Returns whether this album contains any other albums or images. + * Returns whether this album is an identitiy’s root album. * - * @return {@code true} if this album is empty, {@code false} otherwise + * @return {@code true} if this album is an identity’s root album, {@code + * false} otherwise */ - public boolean isEmpty() { - return albums.isEmpty() && images.isEmpty(); - } + boolean isRoot(); /** * Returns the parent album of this album. * - * @return The parent album of this album, or {@code null} if this album - * does not have a parent + * @return The parent album of this album, or {@code null} if this album does + * not have a parent */ - public Album getParent() { - return parent; - } + Album getParent(); /** * Sets the parent album of this album. * * @param parent - * The new parent album of this album + * The new parent album of this album * @return This album */ - protected Album setParent(Album parent) { - Validation.begin().isNotNull("Album Parent", parent).check(); - this.parent = parent; - return this; - } + Album setParent(Album parent); /** * Removes the parent album of this album. * * @return This album */ - protected Album removeParent() { - this.parent = null; - return this; - } + Album removeParent(); /** * Returns the title of this album. * * @return The title of this album */ - public String getTitle() { - return title; - } - - /** - * Sets the title of this album. - * - * @param title - * The title of this album - * @return This album - */ - public Album setTitle(String title) { - Validation.begin().isNotNull("Album Title", title).check(); - this.title = title; - return this; - } + String getTitle(); /** * Returns the description of this album. * * @return The description of this album */ - public String getDescription() { - return description; - } + 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 */ - public Album setDescription(String description) { - Validation.begin().isNotNull("Album Description", description).check(); - this.description = description; - return this; - } - - // - // FINGERPRINTABLE METHODS - // + Modifier modify() throws IllegalStateException; /** - * {@inheritDoc} + * Allows modifying an album. Modifications are only performed once {@link + * #update()} has succesfully returned a new album with the modifications + * made. */ - @Override - public String getFingerprint() { - StringBuilder fingerprint = new StringBuilder(); - fingerprint.append("Album("); - fingerprint.append("ID(").append(id).append(')'); - fingerprint.append("Title(").append(title).append(')'); - fingerprint.append("Description(").append(description).append(')'); - if (albumImage != null) { - fingerprint.append("AlbumImage(").append(albumImage).append(')'); - } + interface Modifier { - /* add nested albums. */ - fingerprint.append("Albums("); - for (Album album : albums) { - fingerprint.append(album.getFingerprint()); - } - fingerprint.append(')'); + Modifier setTitle(String title); - /* add images. */ - fingerprint.append("Images("); - for (Image image : getImages()) { - if (image.isInserted()) { - fingerprint.append(image.getFingerprint()); - } - } - fingerprint.append(')'); + Modifier setDescription(String description); - fingerprint.append(')'); - return fingerprint.toString(); - } + Album update() throws IllegalStateException; - // - // OBJECT METHODS - // + class AlbumTitleMustNotBeEmpty extends IllegalStateException { } - /** - * {@inheritDoc} - */ - @Override - public int hashCode() { - return id.hashCode(); - } - - /** - * {@inheritDoc} - */ - @Override - public boolean equals(Object object) { - if (!(object instanceof Album)) { - return false; - } - Album album = (Album) object; - return id.equals(album.id); } }