X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FAlbum.java;h=20862a4647300e904d04995abbde7d244772ba16;hb=0df5e91852f737d760c5a9f54c5667309fbadcc2;hp=919f79743b78631dbb52cb8cc90b0a6035c52a44;hpb=129815864bbd3cf5ce221eac24e29e2d0e9df036;p=Sone.git
diff --git a/src/main/java/net/pterodactylus/sone/data/Album.java b/src/main/java/net/pterodactylus/sone/data/Album.java
index 919f797..20862a4 100644
--- a/src/main/java/net/pterodactylus/sone/data/Album.java
+++ b/src/main/java/net/pterodactylus/sone/data/Album.java
@@ -21,28 +21,39 @@ import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
+import net.pterodactylus.util.validation.Validation;
+
/**
* Container for images that can also contain nested {@link Album}s.
*
* @author David âBombeâ Roden
*/
-public class Album {
+public class Album implements Fingerprintable {
/** 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 images in this album. */
private final List images = new ArrayList();
- /** The name of this album. */
- private String name;
+ /** The parent album. */
+ private Album parent;
+
+ /** The title of this album. */
+ private String title;
/** The description of this album. */
private String description;
+ /** The index of the album picture. */
+ private int albumImage = -1;
+
/**
* Creates a new album with a random ID.
*/
@@ -57,6 +68,7 @@ public class Album {
* The ID of the album
*/
public Album(String id) {
+ Validation.begin().isNotNull("Album ID", id).check();
this.id = id;
}
@@ -74,15 +86,64 @@ public class Album {
}
/**
+ * 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;
+ }
+
+ /**
* Returns the nested albums.
*
* @return The nested albums
*/
- public List getNestedAlbums() {
+ public List getAlbums() {
return new ArrayList(albums);
}
/**
+ * Adds an album to this album.
+ *
+ * @param album
+ * 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);
+ }
+ }
+
+ /**
+ * Removes an album from this album.
+ *
+ * @param album
+ * 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();
+ }
+
+ /**
* Returns the images in this album.
*
* @return The images in this album
@@ -92,23 +153,107 @@ public class Album {
}
/**
- * Returns the name of this album.
+ * Adds the given image to this album.
+ *
+ * @param image
+ * 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 (!images.contains(image)) {
+ images.add(image);
+ }
+ }
+
+ /**
+ * Removes the given image from this album.
+ *
+ * @param image
+ * The image to remove
+ */
+ public void removeImage(Image image) {
+ Validation.begin().isNotNull("Image", image).check().isEqual("Image Owner", image.getSone(), sone).check();
+ images.remove(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
+ */
+ public Image getAlbumImage() {
+ if (albumImage == -1) {
+ return null;
+ }
+ return images.get(albumImage);
+ }
+
+ /**
+ * Returns whether this album contains any other albums or images.
*
- * @return The name of this album
+ * @return {@code true} if this album is empty, {@code false} otherwise
*/
- public String getName() {
- return name;
+ public boolean isEmpty() {
+ return albums.isEmpty() && images.isEmpty();
}
/**
- * Sets the name of this album.
+ * Returns the parent album of this album.
*
- * @param name
- * The name of this album
+ * @return The parent album of this album, or {@code null} if this album
+ * does not have a parent
+ */
+ public Album getParent() {
+ return parent;
+ }
+
+ /**
+ * Sets the parent album of this album.
+ *
+ * @param parent
+ * 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;
+ }
+
+ /**
+ * Removes the parent album of this album.
+ *
+ * @return This album
+ */
+ protected Album removeParent() {
+ this.parent = null;
+ return this;
+ }
+
+ /**
+ * 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 setName(String name) {
- this.name = name;
+ public Album setTitle(String title) {
+ Validation.begin().isNotNull("Album Title", title).check();
+ this.title = title;
return this;
}
@@ -129,11 +274,47 @@ public class Album {
* @return This album
*/
public Album setDescription(String description) {
+ Validation.begin().isNotNull("Album Description", description).check();
this.description = description;
return this;
}
//
+ // FINGERPRINTABLE METHODS
+ //
+
+ /**
+ * {@inheritDoc}
+ */
+ @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(')');
+
+ /* add nested albums. */
+ fingerprint.append("Albums(");
+ for (Album album : albums) {
+ fingerprint.append(album.getFingerprint());
+ }
+ fingerprint.append(')');
+
+ /* add images. */
+ fingerprint.append("Images(");
+ for (Image image : images) {
+ if (image.isInserted()) {
+ fingerprint.append(image.getFingerprint());
+ }
+ }
+ fingerprint.append(')');
+
+ fingerprint.append(')');
+ return fingerprint.toString();
+ }
+
+ //
// OBJECT METHODS
//
@@ -141,6 +322,14 @@ public class Album {
* {@inheritDoc}
*/
@Override
+ public int hashCode() {
+ return id.hashCode();
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public boolean equals(Object object) {
if (!(object instanceof Album)) {
return false;