Add isEmpty() method.

[Sone.git] / src / main / java / net / pterodactylus / sone / data / Album.java

diff --git a/src/main/java/net/pterodactylus/sone/data/Album.java b/src/main/java/net/pterodactylus/sone/data/Album.java
index 62357d1..d7df845 100644 (file)
--- a/src/main/java/net/pterodactylus/sone/data/Album.java
+++ b/src/main/java/net/pterodactylus/sone/data/Album.java
@@ -28,13 +28,13 @@ import net.pterodactylus.util.validation.Validation;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Album {
+public class Album implements Fingerprintable {
 
        /** The ID of this album. */
        private final String id;
 
        /** The Sone this album belongs to. */
-       private final Sone sone;
+       private Sone sone;
 
        /** Nested albums. */
        private final List<Album> albums = new ArrayList<Album>();
@@ -45,20 +45,20 @@ public class Album {
        /** 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 index of the album picture. */
+       private int albumImage = -1;
+
        /**
         * Creates a new album with a random ID.
-        *
-        * @param sone
-        *            The Sone this album belongs to
         */
-       public Album(Sone sone) {
-               this(UUID.randomUUID().toString(), sone);
+       public Album() {
+               this(UUID.randomUUID().toString());
        }
 
        /**
@@ -66,13 +66,10 @@ public class Album {
         *
         * @param id
         *            The ID of the album
-        * @param sone
-        *            The Sone this album belongs to
         */
-       public Album(String id, Sone sone) {
-               Validation.begin().isNotNull("Album ID", id).isNotNull("Album Owner", sone).check();
+       public Album(String id) {
+               Validation.begin().isNotNull("Album ID", id).check();
                this.id = id;
-               this.sone = sone;
        }
 
        //
@@ -98,11 +95,25 @@ public class Album {
        }
 
        /**
+        * 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().isNull("Current Album Owner", this.sone).isNotNull("New Album Owner", sone).check();
+               this.sone = sone;
+               return this;
+       }
+
+       /**
         * Returns the nested albums.
         *
         * @return The nested albums
         */
-       public List<Album> getNestedAlbums() {
+       public List<Album> getAlbums() {
                return new ArrayList<Album>(albums);
        }
 
@@ -146,7 +157,8 @@ public class Album {
         *            The image to add
         */
        public void addImage(Image image) {
-               Validation.begin().isNotNull("Image", image).check().isEqual("Image Owner", image.getSone(), sone).check();
+               Validation.begin().isNotNull("Image", image).check().isNotNull("Image Owner", image.getSone()).check().isEqual("Image Owner", image.getSone(), sone).check();
+               image.setAlbum(this);
                images.add(image);
        }
 
@@ -162,6 +174,28 @@ public class Album {
        }
 
        /**
+        * 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 {@code true} if this album is empty, {@code false} otherwise
+        */
+       public boolean isEmpty() {
+               return albums.isEmpty() && images.isEmpty();
+       }
+
+       /**
         * Returns the parent album of this album.
         *
         * @return The parent album of this album, or {@code null} if this album
@@ -196,24 +230,24 @@ public class Album {
        }
 
        /**
-        * 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;
        }
 
@@ -240,6 +274,39 @@ public class Album {
        }
 
        //
+       // 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) {
+                       fingerprint.append(image.getFingerprint());
+               }
+               fingerprint.append(')');
+
+               fingerprint.append(')');
+               return fingerprint.toString();
+       }
+
+       //
        // OBJECT METHODS
        //
 
@@ -247,12 +314,20 @@ public class Album {
         * {@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 sone.equals(album.sone) && id.equals(album.id);
+               return id.equals(album.id);
        }
 
 }