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().isNotNull("New Album Owner", sone).isEither("Old Album Owner", this.sone, null, 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).isEither("Old Album Parent", this.parent, null, album.parent).check();
 128                 album.setParent(this);
 129                 if (!albums.contains(album)) {
 130                         albums.add(album);
 131                 }
 132         }
 133
 134         /**
 135          * Removes an album from this album.
 136          *
 137          * @param album
 138          *            The album to remove
 139          */
 140         public void removeAlbum(Album album) {
 141                 Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.sone, sone).isEqual("Album Parent", album.parent, this).check();
 142                 albums.remove(album);
 143                 album.removeParent();
 144         }
 145
 146         /**
 147          * Returns the images in this album.
 148          *
 149          * @return The images in this album
 150          */
 151         public List<Image> getImages() {
 152                 return new ArrayList<Image>(images);
 153         }
 154
 155         /**
 156          * Adds the given image to this album.
 157          *
 158          * @param image
 159          *            The image to add
 160          */
 161         public void addImage(Image image) {
 162                 Validation.begin().isNotNull("Image", image).check().isNotNull("Image Owner", image.getSone()).check().isEqual("Image Owner", image.getSone(), sone).check();
 163                 image.setAlbum(this);
 164                 if (!images.contains(image)) {
 165                         images.add(image);
 166                 }
 167         }
 168
 169         /**
 170          * Removes the given image from this album.
 171          *
 172          * @param image
 173          *            The image to remove
 174          */
 175         public void removeImage(Image image) {
 176                 Validation.begin().isNotNull("Image", image).check().isEqual("Image Owner", image.getSone(), sone).check();
 177                 images.remove(image);
 178         }
 179
 180         /**
 181          * Returns the album image of this album, or {@code null} if no album image
 182          * has been set.
 183          *
 184          * @return The image to show when this album is listed
 185          */
 186         public Image getAlbumImage() {
 187                 if (albumImage == -1) {
 188                         return null;
 189                 }
 190                 return images.get(albumImage);
 191         }
 192
 193         /**
 194          * Returns whether this album contains any other albums or images.
 195          *
 196          * @return {@code true} if this album is empty, {@code false} otherwise
 197          */
 198         public boolean isEmpty() {
 199                 return albums.isEmpty() && images.isEmpty();
 200         }
 201
 202         /**
 203          * Returns the parent album of this album.
 204          *
 205          * @return The parent album of this album, or {@code null} if this album
 206          *         does not have a parent
 207          */
 208         public Album getParent() {
 209                 return parent;
 210         }
 211
 212         /**
 213          * Sets the parent album of this album.
 214          *
 215          * @param parent
 216          *            The new parent album of this album
 217          * @return This album
 218          */
 219         protected Album setParent(Album parent) {
 220                 Validation.begin().isNotNull("Album Parent", parent).check();
 221                 this.parent = parent;
 222                 return this;
 223         }
 224
 225         /**
 226          * Removes the parent album of this album.
 227          *
 228          * @return This album
 229          */
 230         protected Album removeParent() {
 231                 this.parent = null;
 232                 return this;
 233         }
 234
 235         /**
 236          * Returns the title of this album.
 237          *
 238          * @return The title of this album
 239          */
 240         public String getTitle() {
 241                 return title;
 242         }
 243
 244         /**
 245          * Sets the title of this album.
 246          *
 247          * @param title
 248          *            The title of this album
 249          * @return This album
 250          */
 251         public Album setTitle(String title) {
 252                 Validation.begin().isNotNull("Album Title", title).check();
 253                 this.title = title;
 254                 return this;
 255         }
 256
 257         /**
 258          * Returns the description of this album.
 259          *
 260          * @return The description of this album
 261          */
 262         public String getDescription() {
 263                 return description;
 264         }
 265
 266         /**
 267          * Sets the description of this album.
 268          *
 269          * @param description
 270          *            The description of this album
 271          * @return This album
 272          */
 273         public Album setDescription(String description) {
 274                 Validation.begin().isNotNull("Album Description", description).check();
 275                 this.description = description;
 276                 return this;
 277         }
 278
 279         //
 280         // FINGERPRINTABLE METHODS
 281         //
 282
 283         /**
 284          * {@inheritDoc}
 285          */
 286         @Override
 287         public String getFingerprint() {
 288                 StringBuilder fingerprint = new StringBuilder();
 289                 fingerprint.append("Album(");
 290                 fingerprint.append("ID(").append(id).append(')');
 291                 fingerprint.append("Title(").append(title).append(')');
 292                 fingerprint.append("Description(").append(description).append(')');
 293
 294                 /* add nested albums. */
 295                 fingerprint.append("Albums(");
 296                 for (Album album : albums) {
 297                         fingerprint.append(album.getFingerprint());
 298                 }
 299                 fingerprint.append(')');
 300
 301                 /* add images. */
 302                 fingerprint.append("Images(");
 303                 for (Image image : images) {
 304                         if (image.isInserted()) {
 305                                 fingerprint.append(image.getFingerprint());
 306                         }
 307                 }
 308                 fingerprint.append(')');
 309
 310                 fingerprint.append(')');
 311                 return fingerprint.toString();
 312         }
 313
 314         //
 315         // OBJECT METHODS
 316         //
 317
 318         /**
 319          * {@inheritDoc}
 320          */
 321         @Override
 322         public int hashCode() {
 323                 return id.hashCode();
 324         }
 325
 326         /**
 327          * {@inheritDoc}
 328          */
 329         @Override
 330         public boolean equals(Object object) {
 331                 if (!(object instanceof Album)) {
 332                         return false;
 333                 }
 334                 Album album = (Album) object;
 335                 return id.equals(album.id);
 336         }
 337
 338 }