X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FAlbum.java;h=9d990fe4f4b8711d7db254c629634c1e81d4e667;hp=60fb296373a037dc7d8237415ecf00b772199169;hb=a47643aed43d118ca68044f95451bb5374cdb332;hpb=92230f170b37ac854ae07c43d04ab4ec0df163f9 diff --git a/src/main/java/net/pterodactylus/sone/data/Album.java b/src/main/java/net/pterodactylus/sone/data/Album.java index 60fb296..9d990fe 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–2012 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 @@ -18,9 +18,15 @@ package net.pterodactylus.sone.data; import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.UUID; +import net.pterodactylus.util.collection.Mapper; +import net.pterodactylus.util.collection.Mappers; +import net.pterodactylus.util.object.Default; import net.pterodactylus.util.validation.Validation; /** @@ -30,6 +36,15 @@ import net.pterodactylus.util.validation.Validation; */ public class Album implements Fingerprintable { + /** Compares two {@link Album}s by {@link #getTitle()}. */ + public static final Comparator TITLE_COMPARATOR = new Comparator() { + + @Override + public int compare(Album leftAlbum, Album rightAlbum) { + return leftAlbum.getTitle().compareToIgnoreCase(rightAlbum.getTitle()); + } + }; + /** The ID of this album. */ private final String id; @@ -39,18 +54,24 @@ public class Album implements Fingerprintable { /** 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 List images = new ArrayList(); + private final Map images = new HashMap(); /** The parent album. */ private Album parent; - /** The name of this album. */ - private String name; + /** The title of this album. */ + private String title; /** The description of this album. */ private String description; + /** The ID of the album picture. */ + private String albumImage; + /** * Creates a new album with a random ID. */ @@ -100,7 +121,7 @@ public class Album implements Fingerprintable { * @return This album */ public Album setSone(Sone sone) { - Validation.begin().isNull("Current Album Owner", this.sone).isNotNull("New Album Owner", sone).check().isEqual("New Album Owner", sone, this.sone).check(); + Validation.begin().isNotNull("New Album Owner", sone).isEither("Old Album Owner", this.sone, null, sone).check(); this.sone = sone; return this; } @@ -110,7 +131,7 @@ public class Album implements Fingerprintable { * * @return The nested albums */ - public List getNestedAlbums() { + public List getAlbums() { return new ArrayList(albums); } @@ -121,9 +142,11 @@ public class Album implements Fingerprintable { * The album to add */ public void addAlbum(Album album) { - Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isNull("Album Parent", album.parent).check(); - albums.add(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); + } } /** @@ -139,12 +162,60 @@ public class Album implements Fingerprintable { } /** + * 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 + * @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); + } + + /** + * 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 + * @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); + } + + /** * Returns the images in this album. * * @return The images in this album */ public List getImages() { - return new ArrayList(images); + return Mappers.mappedList(imageIds, new Mapper() { + + @Override + @SuppressWarnings("synthetic-access") + public Image map(String imageId) { + return images.get(imageId); + } + + }); } /** @@ -154,8 +225,18 @@ public class Album implements Fingerprintable { * The image to add */ public void addImage(Image image) { - Validation.begin().isNotNull("Image", image).check().isEqual("Image Owner", image.getSone(), sone).check(); - images.add(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); + } } /** @@ -166,7 +247,89 @@ public class Album implements Fingerprintable { */ public void removeImage(Image image) { Validation.begin().isNotNull("Image", image).check().isEqual("Image Owner", image.getSone(), sone).check(); - images.remove(image); + 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(); + } + } + } + + /** + * 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 + * @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)); + } + + /** + * 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 + * @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()); + } + + /** + * Sets the ID of the album image. + * + * @param id + * The ID of the album image + * @return This album + */ + public Album setAlbumImage(String id) { + this.albumImage = id; + return this; + } + + /** + * Returns whether this album contains any other albums or images. + * + * @return {@code true} if this album is empty, {@code false} otherwise + */ + public boolean isEmpty() { + return albums.isEmpty() && images.isEmpty(); } /** @@ -198,30 +361,29 @@ public class Album implements Fingerprintable { * @return This album */ protected Album removeParent() { - Validation.begin().isNotNull("Album Parent", parent).check(); this.parent = null; return this; } /** - * Returns the name of this album. + * Returns the title of this album. * - * @return The name of this album + * @return The title of this album */ - public String getName() { - return name; + public String getTitle() { + return title; } /** - * Sets the name of this album. + * Sets the title of this album. * - * @param name - * The name of this album + * @param title + * The title of this album * @return This album */ - public Album setName(String name) { - Validation.begin().isNotNull("Album Name", name).check(); - this.name = name; + public Album setTitle(String title) { + Validation.begin().isNotNull("Album Title", title).check(); + this.title = title; return this; } @@ -259,8 +421,11 @@ public class Album implements Fingerprintable { StringBuilder fingerprint = new StringBuilder(); fingerprint.append("Album("); fingerprint.append("ID(").append(id).append(')'); - fingerprint.append("Name(").append(name).append(')'); + fingerprint.append("Title(").append(title).append(')'); fingerprint.append("Description(").append(description).append(')'); + if (albumImage != null) { + fingerprint.append("AlbumImage(").append(albumImage).append(')'); + } /* add nested albums. */ fingerprint.append("Albums("); @@ -271,8 +436,10 @@ public class Album implements Fingerprintable { /* add images. */ fingerprint.append("Images("); - for (Image image : images) { - fingerprint.append(image.getFingerprint()); + for (Image image : getImages()) { + if (image.isInserted()) { + fingerprint.append(image.getFingerprint()); + } } fingerprint.append(')'); @@ -288,6 +455,14 @@ public class Album implements Fingerprintable { * {@inheritDoc} */ @Override + public int hashCode() { + return id.hashCode(); + } + + /** + * {@inheritDoc} + */ + @Override public boolean equals(Object object) { if (!(object instanceof Album)) { return false;