src/main/java/net/pterodactylus/sone/data/Album.java

   1 /*
   2  * Sone - Album.java - Copyright © 2011 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.data;
  19
  20 import java.util.ArrayList;
  21 import java.util.List;
  22 import java.util.UUID;
  23
  24 import net.pterodactylus.util.validation.Validation;
  25
  26 /**
  27  * Container for images that can also contain nested {@link Album}s.
  28  *
  29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  30  */
  31 public class Album implements Fingerprintable {
  32
  33         /** The ID of this album. */
  34         private final String id;
  35
  36         /** The Sone this album belongs to. */
  37         private Sone sone;
  38
  39         /** Nested albums. */
  40         private final List<Album> albums = new ArrayList<Album>();
  41
  42         /** The images in this album. */
  43         private final List<Image> images = new ArrayList<Image>();
  44
  45         /** The parent album. */
  46         private Album parent;
  47
  48         /** The title of this album. */
  49         private String title;
  50
  51         /** The description of this album. */
  52         private String description;
  53
  54         /** The index of the album picture. */
  55         private int albumImage = -1;
  56
  57         /**
  58          * Creates a new album with a random ID.
  59          */
  60         public Album() {
  61                 this(UUID.randomUUID().toString());
  62         }
  63
  64         /**
  65          * Creates a new album with the given ID.
  66          *
  67          * @param id
  68          *            The ID of the album
  69          */
  70         public Album(String id) {
  71                 Validation.begin().isNotNull("Album ID", id).check();
  72                 this.id = id;
  73         }
  74
  75         //
  76         // ACCESSORS
  77         //
  78
  79         /**
  80          * Returns the ID of this album.
  81          *
  82          * @return The ID of this album
  83          */
  84         public String getId() {
  85                 return id;
  86         }
  87
  88         /**
  89          * Returns the Sone this album belongs to.
  90          *
  91          * @return The Sone this album belongs to
  92          */
  93         public Sone getSone() {
  94                 return sone;
  95         }
  96
  97         /**
  98          * Sets the owner of the album. The owner can only be set as long as the
  99          * current owner is {@code null}.
 100          *
 101          * @param sone
 102          *            The album owner
 103          * @return This album
 104          */
 105         public Album setSone(Sone sone) {
 106                 Validation.begin().isNull("Current Album Owner", this.sone).isNotNull("New Album Owner", sone).check();
 107                 this.sone = sone;
 108                 return this;
 109         }
 110
 111         /**
 112          * Returns the nested albums.
 113          *
 114          * @return The nested albums
 115          */
 116         public List<Album> getAlbums() {
 117                 return new ArrayList<Album>(albums);
 118         }
 119
 120         /**
 121          * Adds an album to this album.
 122          *
 123          * @param album
 124          *            The album to add
 125          */
 126         public void addAlbum(Album album) {
 127                 Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isNull("Album Parent", album.parent).check();
 128                 albums.add(album);
 129                 album.setParent(this);
 130         }
 131
 132         /**
 133          * Removes an album from this album.
 134          *
 135          * @param album
 136          *            The album to remove
 137          */
 138         public void removeAlbum(Album album) {
 139                 Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isEqual("Album Parent", album.parent, this).check();
 140                 albums.remove(album);
 141                 album.removeParent();
 142         }
 143
 144         /**
 145          * Returns the images in this album.
 146          *
 147          * @return The images in this album
 148          */
 149         public List<Image> getImages() {
 150                 return new ArrayList<Image>(images);
 151         }
 152
 153         /**
 154          * Adds the given image to this album.
 155          *
 156          * @param image
 157          *            The image to add
 158          */
 159         public void addImage(Image image) {
 160                 Validation.begin().isNotNull("Image", image).check().isNotNull("Image Owner", image.getSone()).check().isEqual("Image Owner", image.getSone(), sone).check();
 161                 image.setAlbum(this);
 162                 images.add(image);
 163         }
 164
 165         /**
 166          * Removes the given image from this album.
 167          *
 168          * @param image
 169          *            The image to remove
 170          */
 171         public void removeImage(Image image) {
 172                 Validation.begin().isNotNull("Image", image).check().isEqual("Image Owner", image.getSone(), sone).check();
 173                 images.remove(image);
 174         }
 175
 176         /**
 177          * Returns the album image of this album, or {@code null} if no album image
 178          * has been set.
 179          *
 180          * @return The image to show when this album is listed
 181          */
 182         public Image getAlbumImage() {
 183                 if (albumImage == -1) {
 184                         return null;
 185                 }
 186                 return images.get(albumImage);
 187         }
 188
 189         /**
 190          * Returns whether this album contains any other albums or images.
 191          *
 192          * @return {@code true} if this album is empty, {@code false} otherwise
 193          */
 194         public boolean isEmpty() {
 195                 return albums.isEmpty() && images.isEmpty();
 196         }
 197
 198         /**
 199          * Returns the parent album of this album.
 200          *
 201          * @return The parent album of this album, or {@code null} if this album
 202          *         does not have a parent
 203          */
 204         public Album getParent() {
 205                 return parent;
 206         }
 207
 208         /**
 209          * Sets the parent album of this album.
 210          *
 211          * @param parent
 212          *            The new parent album of this album
 213          * @return This album
 214          */
 215         protected Album setParent(Album parent) {
 216                 Validation.begin().isNotNull("Album Parent", parent).check();
 217                 this.parent = parent;
 218                 return this;
 219         }
 220
 221         /**
 222          * Removes the parent album of this album.
 223          *
 224          * @return This album
 225          */
 226         protected Album removeParent() {
 227                 Validation.begin().isNotNull("Album Parent", parent).check();
 228                 this.parent = null;
 229                 return this;
 230         }
 231
 232         /**
 233          * Returns the title of this album.
 234          *
 235          * @return The title of this album
 236          */
 237         public String getTitle() {
 238                 return title;
 239         }
 240
 241         /**
 242          * Sets the title of this album.
 243          *
 244          * @param title
 245          *            The title of this album
 246          * @return This album
 247          */
 248         public Album setTitle(String title) {
 249                 Validation.begin().isNotNull("Album Title", title).check();
 250                 this.title = title;
 251                 return this;
 252         }
 253
 254         /**
 255          * Returns the description of this album.
 256          *
 257          * @return The description of this album
 258          */
 259         public String getDescription() {
 260                 return description;
 261         }
 262
 263         /**
 264          * Sets the description of this album.
 265          *
 266          * @param description
 267          *            The description of this album
 268          * @return This album
 269          */
 270         public Album setDescription(String description) {
 271                 Validation.begin().isNotNull("Album Description", description).check();
 272                 this.description = description;
 273                 return this;
 274         }
 275
 276         //
 277         // FINGERPRINTABLE METHODS
 278         //
 279
 280         /**
 281          * {@inheritDoc}
 282          */
 283         @Override
 284         public String getFingerprint() {
 285                 StringBuilder fingerprint = new StringBuilder();
 286                 fingerprint.append("Album(");
 287                 fingerprint.append("ID(").append(id).append(')');
 288                 fingerprint.append("Title(").append(title).append(')');
 289                 fingerprint.append("Description(").append(description).append(')');
 290
 291                 /* add nested albums. */
 292                 fingerprint.append("Albums(");
 293                 for (Album album : albums) {
 294                         fingerprint.append(album.getFingerprint());
 295                 }
 296                 fingerprint.append(')');
 297
 298                 /* add images. */
 299                 fingerprint.append("Images(");
 300                 for (Image image : images) {
 301                         fingerprint.append(image.getFingerprint());
 302                 }
 303                 fingerprint.append(')');
 304
 305                 fingerprint.append(')');
 306                 return fingerprint.toString();
 307         }
 308
 309         //
 310         // OBJECT METHODS
 311         //
 312
 313         /**
 314          * {@inheritDoc}
 315          */
 316         @Override
 317         public int hashCode() {
 318                 return id.hashCode();
 319         }
 320
 321         /**
 322          * {@inheritDoc}
 323          */
 324         @Override
 325         public boolean equals(Object object) {
 326                 if (!(object instanceof Album)) {
 327                         return false;
 328                 }
 329                 Album album = (Album) object;
 330                 return id.equals(album.id);
 331         }
 332
 333 }