X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FAlbum.java;h=d7df84571084e3521d02920bd273ec4f388e5c7b;hp=792f5181ecd2ed9279435528b5da3c8dbe83ee98;hb=147ca6215b8c951ad46e56f919c077e6c0f66ee2;hpb=cf9d466a99e30e2c23694da9037c12de6372aaae diff --git a/src/main/java/net/pterodactylus/sone/data/Album.java b/src/main/java/net/pterodactylus/sone/data/Album.java index 792f518..d7df845 100644 --- 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 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 final Sone sone; + private Sone sone; /** Nested albums. */ private final List albums = new ArrayList(); @@ -42,20 +42,23 @@ public class Album { /** 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. - * - * @param sone - * The Sone this album belongs to */ - public Album(Sone sone) { - this(UUID.randomUUID().toString(), sone); + public Album() { + this(UUID.randomUUID().toString()); } /** @@ -63,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; } // @@ -95,15 +95,53 @@ 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 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).isNull("Album Parent", album.parent).check(); + albums.add(album); + album.setParent(this); + } + + /** + * 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 @@ -113,24 +151,103 @@ public class Album { } /** - * Returns the name of this album. + * Adds the given image to this album. * - * @return The name of this album + * @param image + * The image to add */ - public String getName() { - return name; + public void addImage(Image image) { + 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); } /** - * Sets the name of this album. + * Removes the given image from this album. * - * @param name - * The name of 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 {@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 + * 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() { + Validation.begin().isNotNull("Album Parent", parent).check(); + 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) { - 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; } @@ -157,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 // @@ -164,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); } }