Insert a root album into all Sones to get rid of album manipulation in the Sone.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Sone.java
index 8b08b17..22dc593 100644 (file)
 
 package net.pterodactylus.sone.data;
 
-import static com.google.common.base.Preconditions.checkArgument;
-import static com.google.common.base.Preconditions.checkNotNull;
+import static com.google.common.base.Preconditions.*;
+import static com.google.common.collect.FluentIterable.from;
+import static java.util.Arrays.asList;
+import static net.pterodactylus.sone.data.Album.FLATTENER;
+import static net.pterodactylus.sone.data.Album.IMAGES;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -26,7 +29,6 @@ import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Set;
-import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.CopyOnWriteArraySet;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -37,17 +39,17 @@ import net.pterodactylus.sone.freenet.wot.OwnIdentity;
 import net.pterodactylus.sone.template.SoneAccessor;
 import net.pterodactylus.util.logging.Logging;
 
+import freenet.keys.FreenetURI;
+
 import com.google.common.base.Predicate;
-import com.google.common.collect.FluentIterable;
 import com.google.common.hash.Hasher;
 import com.google.common.hash.Hashing;
-
-import freenet.keys.FreenetURI;
+import com.google.common.primitives.Ints;
 
 /**
  * A Sone defines everything about a user: her profile, her status updates, her
  * replies, her likes and dislikes, etc.
- * <p>
+ * <p/>
  * Operations that modify the Sone need to synchronize on the Sone in question.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
@@ -112,9 +114,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
 
        };
 
-       /**
-        * Comparator that sorts Sones by last activity (least recent active first).
-        */
+       /** Comparator that sorts Sones by last activity (least recent active first). */
        public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
 
                @Override
@@ -143,7 +143,10 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
                 */
                @Override
                public int compare(Sone leftSone, Sone rightSone) {
-                       return rightSone.getAllImages().size() - leftSone.getAllImages().size();
+                       int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
+                       int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
+                       /* sort descending. */
+                       return Ints.compare(rightSoneImageCount, leftSoneImageCount);
                }
        };
 
@@ -171,7 +174,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
 
                @Override
                public boolean apply(Sone sone) {
-                       return !sone.getAlbums().isEmpty();
+                       return !sone.getRootAlbum().getAlbums().isEmpty();
                }
        };
 
@@ -227,8 +230,8 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        /** The IDs of all liked replies. */
        private final Set<String> likedReplyIds = new CopyOnWriteArraySet<String>();
 
-       /** The albums of this Sone. */
-       private final List<Album> albums = new CopyOnWriteArrayList<Album>();
+       /** The root album containing all albums. */
+       private final Album rootAlbum = new Album().setSone(this);
 
        /** Sone-specific options. */
        private Options options = new Options();
@@ -237,10 +240,9 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Creates a new Sone.
         *
         * @param id
-        *            The ID of the Sone
+        *              The ID of the Sone
         * @param local
-        *            {@code true} if the Sone is a local Sone, {@code false}
-        *            otherwise
+        *              {@code true} if the Sone is a local Sone, {@code false} otherwise
         */
        public Sone(String id, boolean local) {
                this.id = id;
@@ -274,10 +276,10 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * identity has to match this Sone’s {@link #getId()}.
         *
         * @param identity
-        *            The identity of this Sone
+        *              The identity of this Sone
         * @return This Sone (for method chaining)
         * @throws IllegalArgumentException
-        *             if the ID of the identity does not match this Sone’s ID
+        *              if the ID of the identity does not match this Sone’s ID
         */
        public Sone setIdentity(Identity identity) throws IllegalArgumentException {
                if (!identity.getId().equals(id)) {
@@ -299,8 +301,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        /**
         * Returns whether this Sone is a local Sone.
         *
-        * @return {@code true} if this Sone is a local Sone, {@code false}
-        *         otherwise
+        * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
         */
        public boolean isLocal() {
                return local;
@@ -319,7 +320,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the request URI of this Sone.
         *
         * @param requestUri
-        *            The request URI of this Sone
+        *              The request URI of this Sone
         * @return This Sone (for method chaining)
         */
        public Sone setRequestUri(FreenetURI requestUri) {
@@ -347,7 +348,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the insert URI of this Sone.
         *
         * @param insertUri
-        *            The insert URI of this Sone
+        *              The insert URI of this Sone
         * @return This Sone (for method chaining)
         */
        public Sone setInsertUri(FreenetURI insertUri) {
@@ -373,11 +374,11 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
 
        /**
         * Sets the latest edition of this Sone. If the given latest edition is not
-        * greater than the current latest edition, the latest edition of this Sone
-        * is not changed.
+        * greater than the current latest edition, the latest edition of this Sone is
+        * not changed.
         *
         * @param latestEdition
-        *            The latest edition of this Sone
+        *              The latest edition of this Sone
         */
        public void setLatestEdition(long latestEdition) {
                if (!(latestEdition > this.latestEdition)) {
@@ -400,7 +401,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the time of the last inserted update of this Sone.
         *
         * @param time
-        *            The time of the update (in milliseconds since Jan 1, 1970 UTC)
+        *              The time of the update (in milliseconds since Jan 1, 1970 UTC)
         * @return This Sone (for method chaining)
         */
        public Sone setTime(long time) {
@@ -421,10 +422,10 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the new status of this Sone.
         *
         * @param status
-        *            The new status of this Sone
+        *              The new status of this Sone
         * @return This Sone
         * @throws IllegalArgumentException
-        *             if {@code status} is {@code null}
+        *              if {@code status} is {@code null}
         */
        public Sone setStatus(SoneStatus status) {
                this.status = checkNotNull(status, "status must not be null");
@@ -432,9 +433,9 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        }
 
        /**
-        * Returns a copy of the profile. If you want to update values in the
-        * profile of this Sone, update the values in the returned {@link Profile}
-        * and use {@link #setProfile(Profile)} to change the profile in this Sone.
+        * Returns a copy of the profile. If you want to update values in the profile
+        * of this Sone, update the values in the returned {@link Profile} and use
+        * {@link #setProfile(Profile)} to change the profile in this Sone.
         *
         * @return A copy of the profile
         */
@@ -443,12 +444,12 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        }
 
        /**
-        * Sets the profile of this Sone. A copy of the given profile is stored so
-        * that subsequent modifications of the given profile are not reflected in
-        * this Sone!
+        * Sets the profile of this Sone. A copy of the given profile is stored so that
+        * subsequent modifications of the given profile are not reflected in this
+        * Sone!
         *
         * @param profile
-        *            The profile to set
+        *              The profile to set
         */
        public void setProfile(Profile profile) {
                this.profile = new Profile(profile);
@@ -467,7 +468,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the client used by this Sone.
         *
         * @param client
-        *            The client used by this Sone, or {@code null}
+        *              The client used by this Sone, or {@code null}
         * @return This Sone (for method chaining)
         */
        public Sone setClient(Client client) {
@@ -488,7 +489,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets whether this Sone is known.
         *
         * @param known
-        *            {@code true} if this Sone is known, {@code false} otherwise
+        *              {@code true} if this Sone is known, {@code false} otherwise
         * @return This Sone
         */
        public Sone setKnown(boolean known) {
@@ -510,9 +511,9 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Returns whether this Sone has the given Sone as a friend Sone.
         *
         * @param friendSoneId
-        *            The ID of the Sone to check for
-        * @return {@code true} if this Sone has the given Sone as a friend,
-        *         {@code false} otherwise
+        *              The ID of the Sone to check for
+        * @return {@code true} if this Sone has the given Sone as a friend, {@code
+        *         false} otherwise
         */
        public boolean hasFriend(String friendSoneId) {
                return friendSones.contains(friendSoneId);
@@ -522,7 +523,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Adds the given Sone as a friend Sone.
         *
         * @param friendSone
-        *            The friend Sone to add
+        *              The friend Sone to add
         * @return This Sone (for method chaining)
         */
        public Sone addFriend(String friendSone) {
@@ -536,7 +537,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Removes the given Sone as a friend Sone.
         *
         * @param friendSoneId
-        *            The ID of the friend Sone to remove
+        *              The ID of the friend Sone to remove
         * @return This Sone (for method chaining)
         */
        public Sone removeFriend(String friendSoneId) {
@@ -562,7 +563,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets all posts of this Sone at once.
         *
         * @param posts
-        *            The new (and only) posts of this Sone
+        *              The new (and only) posts of this Sone
         * @return This Sone (for method chaining)
         */
        public Sone setPosts(Collection<Post> posts) {
@@ -574,11 +575,11 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        }
 
        /**
-        * Adds the given post to this Sone. The post will not be added if its
-        * {@link Post#getSone() Sone} is not this Sone.
+        * Adds the given post to this Sone. The post will not be added if its {@link
+        * Post#getSone() Sone} is not this Sone.
         *
         * @param post
-        *            The post to add
+        *              The post to add
         */
        public void addPost(Post post) {
                if (post.getSone().equals(this) && posts.add(post)) {
@@ -590,7 +591,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Removes the given post from this Sone.
         *
         * @param post
-        *            The post to remove
+        *              The post to remove
         */
        public void removePost(Post post) {
                if (post.getSone().equals(this)) {
@@ -611,7 +612,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets all replies of this Sone at once.
         *
         * @param replies
-        *            The new (and only) replies of this Sone
+        *              The new (and only) replies of this Sone
         * @return This Sone (for method chaining)
         */
        public Sone setReplies(Collection<PostReply> replies) {
@@ -625,7 +626,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * nothing is added to this Sone.
         *
         * @param reply
-        *            The reply to add
+        *              The reply to add
         */
        public void addReply(PostReply reply) {
                if (reply.getSone().equals(this)) {
@@ -637,7 +638,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Removes a reply from this Sone.
         *
         * @param reply
-        *            The reply to remove
+        *              The reply to remove
         */
        public void removeReply(PostReply reply) {
                if (reply.getSone().equals(this)) {
@@ -658,7 +659,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the IDs of all liked posts.
         *
         * @param likedPostIds
-        *            All liked posts’ IDs
+        *              All liked posts’ IDs
         * @return This Sone (for method chaining)
         */
        public Sone setLikePostIds(Set<String> likedPostIds) {
@@ -671,7 +672,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Checks whether the given post ID is liked by this Sone.
         *
         * @param postId
-        *            The ID of the post
+        *              The ID of the post
         * @return {@code true} if this Sone likes the given post, {@code false}
         *         otherwise
         */
@@ -683,7 +684,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Adds the given post ID to the list of posts this Sone likes.
         *
         * @param postId
-        *            The ID of the post
+        *              The ID of the post
         * @return This Sone (for method chaining)
         */
        public Sone addLikedPostId(String postId) {
@@ -695,7 +696,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Removes the given post ID from the list of posts this Sone likes.
         *
         * @param postId
-        *            The ID of the post
+        *              The ID of the post
         * @return This Sone (for method chaining)
         */
        public Sone removeLikedPostId(String postId) {
@@ -716,7 +717,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the IDs of all liked replies.
         *
         * @param likedReplyIds
-        *            All liked replies’ IDs
+        *              All liked replies’ IDs
         * @return This Sone (for method chaining)
         */
        public Sone setLikeReplyIds(Set<String> likedReplyIds) {
@@ -729,7 +730,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Checks whether the given reply ID is liked by this Sone.
         *
         * @param replyId
-        *            The ID of the reply
+        *              The ID of the reply
         * @return {@code true} if this Sone likes the given reply, {@code false}
         *         otherwise
         */
@@ -741,7 +742,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Adds the given reply ID to the list of replies this Sone likes.
         *
         * @param replyId
-        *            The ID of the reply
+        *              The ID of the reply
         * @return This Sone (for method chaining)
         */
        public Sone addLikedReplyId(String replyId) {
@@ -753,7 +754,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Removes the given post ID from the list of replies this Sone likes.
         *
         * @param replyId
-        *            The ID of the reply
+        *              The ID of the reply
         * @return This Sone (for method chaining)
         */
        public Sone removeLikedReplyId(String replyId) {
@@ -762,110 +763,12 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        }
 
        /**
-        * Returns the albums of this Sone.
+        * Returns the root album that contains all visible albums of this Sone.
         *
-        * @return The albums of this Sone
+        * @return The root album of this Sone
         */
-       public List<Album> getAlbums() {
-               return Collections.unmodifiableList(albums);
-       }
-
-       /**
-        * Returns all images of a Sone. Images of a album are inserted into this
-        * list before images of all child albums.
-        *
-        * @return The list of all images
-        */
-       public List<Image> getAllImages() {
-               List<Image> allImages = new ArrayList<Image>();
-               for (Album album : FluentIterable.from(getAlbums()).transformAndConcat(Album.FLATTENER).toList()) {
-                       allImages.addAll(album.getImages());
-               }
-               return allImages;
-       }
-
-       /**
-        * Adds an album to this Sone.
-        *
-        * @param album
-        *            The album to add
-        */
-       public void addAlbum(Album album) {
-               checkNotNull(album, "album must not be null");
-               checkArgument(album.getSone().equals(this), "album must belong to this Sone");
-               if (!albums.contains(album)) {
-                       albums.add(album);
-               }
-       }
-
-       /**
-        * Sets the albums of this Sone.
-        *
-        * @param albums
-        *            The albums of this Sone
-        */
-       public void setAlbums(Collection<? extends Album> albums) {
-               checkNotNull(albums, "albums must not be null");
-               this.albums.clear();
-               for (Album album : albums) {
-                       addAlbum(album);
-               }
-       }
-
-       /**
-        * Removes an album from this Sone.
-        *
-        * @param album
-        *            The album to remove
-        */
-       public void removeAlbum(Album album) {
-               checkNotNull(album, "album must not be null");
-               checkArgument(album.getSone().equals(this), "album must belong to this Sone");
-               albums.remove(album);
-       }
-
-       /**
-        * Moves the given album up in this album’s albums. If the album is already
-        * the first album, nothing happens.
-        *
-        * @param album
-        *            The album to move up
-        * @return The album that the given album swapped the place with, or
-        *         <code>null</code> if the album did not change its place
-        */
-       public Album moveAlbumUp(Album album) {
-               checkNotNull(album, "album must not be null");
-               checkArgument(album.getSone().equals(this), "album must belong to this Sone");
-               checkArgument(album.getParent() == null, "album must not have a parent");
-               int oldIndex = albums.indexOf(album);
-               if (oldIndex <= 0) {
-                       return null;
-               }
-               albums.remove(oldIndex);
-               albums.add(oldIndex - 1, album);
-               return albums.get(oldIndex);
-       }
-
-       /**
-        * Moves the given album down in this album’s albums. If the album is
-        * already the last album, nothing happens.
-        *
-        * @param album
-        *            The album to move down
-        * @return The album that the given album swapped the place with, or
-        *         <code>null</code> if the album did not change its place
-        */
-       public Album moveAlbumDown(Album album) {
-               checkNotNull(album, "album must not be null");
-               checkArgument(album.getSone().equals(this), "album must belong to this Sone");
-               checkArgument(album.getParent() == null, "album must not have a parent");
-               int oldIndex = albums.indexOf(album);
-               if ((oldIndex < 0) || (oldIndex >= (albums.size() - 1))) {
-                       return null;
-               }
-               albums.remove(oldIndex);
-               albums.add(oldIndex + 1, album);
-               return albums.get(oldIndex);
+       public Album getRootAlbum() {
+               return rootAlbum;
        }
 
        /**
@@ -881,7 +784,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
         * Sets the options of this Sone.
         *
         * @param options
-        *            The options of this Sone
+        *              The options of this Sone
         */
        /* TODO - remove this method again, maybe add an option provider */
        public void setOptions(Options options) {
@@ -892,9 +795,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        // FINGERPRINTABLE METHODS
        //
 
-       /**
-        * {@inheritDoc}
-        */
+       /** {@inheritDoc} */
        @Override
        public synchronized String getFingerprint() {
                Hasher hash = Hashing.sha256().newHasher();
@@ -943,9 +844,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        // INTERFACE Comparable<Sone>
        //
 
-       /**
-        * {@inheritDoc}
-        */
+       /** {@inheritDoc} */
        @Override
        public int compareTo(Sone sone) {
                return NICE_NAME_COMPARATOR.compare(this, sone);
@@ -955,17 +854,13 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
        // OBJECT METHODS
        //
 
-       /**
-        * {@inheritDoc}
-        */
+       /** {@inheritDoc} */
        @Override
        public int hashCode() {
                return id.hashCode();
        }
 
-       /**
-        * {@inheritDoc}
-        */
+       /** {@inheritDoc} */
        @Override
        public boolean equals(Object object) {
                if (!(object instanceof Sone)) {
@@ -974,9 +869,7 @@ public class Sone implements Fingerprintable, Comparable<Sone> {
                return ((Sone) object).id.equals(id);
        }
 
-       /**
-        * {@inheritDoc}
-        */
+       /** {@inheritDoc} */
        @Override
        public String toString() {
                return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri(" + String.valueOf(insertUri).length() + "),friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";