Merge branch 'profile-fields' into next
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Sone.java
index 8d6a3a1..03dff75 100644 (file)
@@ -40,7 +40,7 @@ import freenet.keys.FreenetURI;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Sone {
+public class Sone implements Fingerprintable {
 
        /** comparator that sorts Sones by their nice name. */
        public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
@@ -59,8 +59,11 @@ public class Sone {
        /** The logger. */
        private static final Logger logger = Logging.getLogger(Sone.class);
 
+       /** The ID of this Sone. */
+       private final String id;
+
        /** The identity of this Sone. */
-       private final Identity identity;
+       private Identity identity;
 
        /** The URI under which the Sone is stored in Freenet. */
        private volatile FreenetURI requestUri;
@@ -76,10 +79,13 @@ public class Sone {
        private volatile long time;
 
        /** The profile of this Sone. */
-       private volatile Profile profile;
+       private volatile Profile profile = new Profile();
+
+       /** The client used by the Sone. */
+       private volatile Client client;
 
        /** All friend Sones. */
-       private final Set<Sone> friendSones = Collections.synchronizedSet(new HashSet<Sone>());
+       private final Set<String> friendSones = Collections.synchronizedSet(new HashSet<String>());
 
        /** All posts. */
        private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
@@ -93,17 +99,14 @@ public class Sone {
        /** The IDs of all liked replies. */
        private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
 
-       /** Modification count. */
-       private volatile long modificationCounter = 0;
-
        /**
         * Creates a new Sone.
         *
-        * @param identity
-        *            The identity of the Sone
+        * @param id
+        *            The ID of the Sone
         */
-       public Sone(Identity identity) {
-               this.identity = identity;
+       public Sone(String id) {
+               this.id = id;
        }
 
        //
@@ -116,7 +119,7 @@ public class Sone {
         * @return The identity of this Sone
         */
        public String getId() {
-               return identity.getId();
+               return id;
        }
 
        /**
@@ -129,12 +132,30 @@ public class Sone {
        }
 
        /**
+        * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
+        * identity has to match this Sone’s {@link #getId()}.
+        *
+        * @param identity
+        *            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
+        */
+       public Sone setIdentity(Identity identity) throws IllegalArgumentException {
+               if (!identity.getId().equals(id)) {
+                       throw new IllegalArgumentException("Identity’s ID does not match Sone’s ID!");
+               }
+               this.identity = identity;
+               return this;
+       }
+
+       /**
         * Returns the name of this Sone.
         *
         * @return The name of this Sone
         */
        public String getName() {
-               return identity.getNickname();
+               return (identity != null) ? identity.getNickname() : null;
        }
 
        /**
@@ -143,7 +164,7 @@ public class Sone {
         * @return The request URI of this Sone
         */
        public FreenetURI getRequestUri() {
-               return requestUri.setSuggestedEdition(latestEdition);
+               return (requestUri != null) ? requestUri.setSuggestedEdition(latestEdition) : null;
        }
 
        /**
@@ -162,7 +183,6 @@ public class Sone {
                        logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { requestUri, this.requestUri });
                        return this;
                }
-               setLatestEdition(requestUri.getEdition());
                return this;
        }
 
@@ -172,7 +192,7 @@ public class Sone {
         * @return The insert URI of this Sone
         */
        public FreenetURI getInsertUri() {
-               return insertUri.setSuggestedEdition(latestEdition);
+               return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
        }
 
        /**
@@ -191,7 +211,6 @@ public class Sone {
                        logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { insertUri, this.insertUri });
                        return this;
                }
-               setLatestEdition(insertUri.getEdition());
                return this;
        }
 
@@ -248,7 +267,7 @@ public class Sone {
         *
         * @return A copy of the profile
         */
-       public Profile getProfile() {
+       public synchronized Profile getProfile() {
                return new Profile(profile);
        }
 
@@ -262,7 +281,27 @@ public class Sone {
         */
        public synchronized void setProfile(Profile profile) {
                this.profile = new Profile(profile);
-               modificationCounter++;
+       }
+
+       /**
+        * Returns the client used by this Sone.
+        *
+        * @return The client used by this Sone, or {@code null}
+        */
+       public Client getClient() {
+               return client;
+       }
+
+       /**
+        * Sets the client used by this Sone.
+        *
+        * @param client
+        *            The client used by this Sone, or {@code null}
+        * @return This Sone (for method chaining)
+        */
+       public Sone setClient(Client client) {
+               this.client = client;
+               return this;
        }
 
        /**
@@ -270,19 +309,8 @@ public class Sone {
         *
         * @return The friend Sones of this Sone
         */
-       public List<Sone> getFriends() {
-               List<Sone> friends = new ArrayList<Sone>(friendSones);
-               Collections.sort(friends, new Comparator<Sone>() {
-
-                       @Override
-                       public int compare(Sone leftSone, Sone rightSone) {
-                               int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
-                               if (diff != 0) {
-                                       return diff;
-                               }
-                               return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightSone.getTime() - leftSone.getTime()));
-                       }
-               });
+       public List<String> getFriends() {
+               List<String> friends = new ArrayList<String>(friendSones);
                return friends;
        }
 
@@ -293,7 +321,7 @@ public class Sone {
         *            The new (and only) friends of this Sone
         * @return This Sone (for method chaining)
         */
-       public Sone setFriends(Collection<Sone> friends) {
+       public Sone setFriends(Collection<String> friends) {
                friendSones.clear();
                friendSones.addAll(friends);
                return this;
@@ -302,13 +330,13 @@ public class Sone {
        /**
         * Returns whether this Sone has the given Sone as a friend Sone.
         *
-        * @param friendSone
-        *            The friend Sone to check for
+        * @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
         */
-       public boolean hasFriend(Sone friendSone) {
-               return friendSones.contains(friendSone);
+       public boolean hasFriend(String friendSoneId) {
+               return friendSones.contains(friendSoneId);
        }
 
        /**
@@ -318,8 +346,8 @@ public class Sone {
         *            The friend Sone to add
         * @return This Sone (for method chaining)
         */
-       public Sone addFriend(Sone friendSone) {
-               if (!friendSone.equals(this)) {
+       public Sone addFriend(String friendSone) {
+               if (!friendSone.equals(id)) {
                        friendSones.add(friendSone);
                }
                return this;
@@ -328,12 +356,12 @@ public class Sone {
        /**
         * Removes the given Sone as a friend Sone.
         *
-        * @param friendSone
-        *            The friend Sone to remove
+        * @param friendSoneId
+        *            The ID of the friend Sone to remove
         * @return This Sone (for method chaining)
         */
-       public Sone removeFriend(Sone friendSone) {
-               friendSones.remove(friendSone);
+       public Sone removeFriend(String friendSoneId) {
+               friendSones.remove(friendSoneId);
                return this;
        }
 
@@ -343,15 +371,11 @@ public class Sone {
         * @return All posts of this Sone
         */
        public List<Post> getPosts() {
-               List<Post> sortedPosts = new ArrayList<Post>(posts);
-               Collections.sort(sortedPosts, new Comparator<Post>() {
-
-                       @Override
-                       public int compare(Post leftPost, Post rightPost) {
-                               return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
-                       }
-
-               });
+               List<Post> sortedPosts;
+               synchronized (this) {
+                       sortedPosts = new ArrayList<Post>(posts);
+               }
+               Collections.sort(sortedPosts, Post.TIME_COMPARATOR);
                return sortedPosts;
        }
 
@@ -365,7 +389,6 @@ public class Sone {
        public synchronized Sone setPosts(Collection<Post> posts) {
                this.posts.clear();
                this.posts.addAll(posts);
-               modificationCounter++;
                return this;
        }
 
@@ -379,7 +402,6 @@ public class Sone {
        public synchronized void addPost(Post post) {
                if (post.getSone().equals(this) && posts.add(post)) {
                        logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
-                       modificationCounter++;
                }
        }
 
@@ -390,8 +412,8 @@ public class Sone {
         *            The post to remove
         */
        public synchronized void removePost(Post post) {
-               if (post.getSone().equals(this) && posts.remove(post)) {
-                       modificationCounter++;
+               if (post.getSone().equals(this)) {
+                       posts.remove(post);
                }
        }
 
@@ -400,8 +422,7 @@ public class Sone {
         *
         * @return All replies this Sone made
         */
-       public Set<Reply> getReplies() {
-               logger.log(Level.FINEST, "Friends of %s: %s", new Object[] { this, friendSones });
+       public synchronized Set<Reply> getReplies() {
                return Collections.unmodifiableSet(replies);
        }
 
@@ -415,7 +436,6 @@ public class Sone {
        public synchronized Sone setReplies(Collection<Reply> replies) {
                this.replies.clear();
                this.replies.addAll(replies);
-               modificationCounter++;
                return this;
        }
 
@@ -427,8 +447,8 @@ public class Sone {
         *            The reply to add
         */
        public synchronized void addReply(Reply reply) {
-               if (reply.getSone().equals(this) && replies.add(reply)) {
-                       modificationCounter++;
+               if (reply.getSone().equals(this)) {
+                       replies.add(reply);
                }
        }
 
@@ -439,8 +459,8 @@ public class Sone {
         *            The reply to remove
         */
        public synchronized void removeReply(Reply reply) {
-               if (reply.getSone().equals(this) && replies.remove(reply)) {
-                       modificationCounter++;
+               if (reply.getSone().equals(this)) {
+                       replies.remove(reply);
                }
        }
 
@@ -463,7 +483,6 @@ public class Sone {
        public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
                this.likedPostIds.clear();
                this.likedPostIds.addAll(likedPostIds);
-               modificationCounter++;
                return this;
        }
 
@@ -487,9 +506,7 @@ public class Sone {
         * @return This Sone (for method chaining)
         */
        public synchronized Sone addLikedPostId(String postId) {
-               if (likedPostIds.add(postId)) {
-                       modificationCounter++;
-               }
+               likedPostIds.add(postId);
                return this;
        }
 
@@ -501,9 +518,7 @@ public class Sone {
         * @return This Sone (for method chaining)
         */
        public synchronized Sone removeLikedPostId(String postId) {
-               if (likedPostIds.remove(postId)) {
-                       modificationCounter++;
-               }
+               likedPostIds.remove(postId);
                return this;
        }
 
@@ -526,7 +541,6 @@ public class Sone {
        public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
                this.likedReplyIds.clear();
                this.likedReplyIds.addAll(likedReplyIds);
-               modificationCounter++;
                return this;
        }
 
@@ -550,9 +564,7 @@ public class Sone {
         * @return This Sone (for method chaining)
         */
        public synchronized Sone addLikedReplyId(String replyId) {
-               if (likedReplyIds.add(replyId)) {
-                       modificationCounter++;
-               }
+               likedReplyIds.add(replyId);
                return this;
        }
 
@@ -564,29 +576,53 @@ public class Sone {
         * @return This Sone (for method chaining)
         */
        public synchronized Sone removeLikedReplyId(String replyId) {
-               if (likedReplyIds.remove(replyId)) {
-                       modificationCounter++;
-               }
+               likedReplyIds.remove(replyId);
                return this;
        }
 
-       /**
-        * Returns the modification counter.
-        *
-        * @return The modification counter
-        */
-       public synchronized long getModificationCounter() {
-               return modificationCounter;
-       }
+       //
+       // FINGERPRINTABLE METHODS
+       //
 
        /**
-        * Sets the modification counter.
-        *
-        * @param modificationCounter
-        *            The new modification counter
+        * {@inheritDoc}
         */
-       public synchronized void setModificationCounter(long modificationCounter) {
-               this.modificationCounter = modificationCounter;
+       @Override
+       public synchronized String getFingerprint() {
+               StringBuilder fingerprint = new StringBuilder();
+               fingerprint.append(profile.getFingerprint());
+
+               fingerprint.append("Posts(");
+               for (Post post : getPosts()) {
+                       fingerprint.append("Post(").append(post.getId()).append(')');
+               }
+               fingerprint.append(")");
+
+               List<Reply> replies = new ArrayList<Reply>(getReplies());
+               Collections.sort(replies, Reply.TIME_COMPARATOR);
+               fingerprint.append("Replies(");
+               for (Reply reply : replies) {
+                       fingerprint.append("Reply(").append(reply.getId()).append(')');
+               }
+               fingerprint.append(')');
+
+               List<String> likedPostIds = new ArrayList<String>(getLikedPostIds());
+               Collections.sort(likedPostIds);
+               fingerprint.append("LikedPosts(");
+               for (String likedPostId : likedPostIds) {
+                       fingerprint.append("Post(").append(likedPostId).append(')');
+               }
+               fingerprint.append(')');
+
+               List<String> likedReplyIds = new ArrayList<String>(getLikedReplyIds());
+               Collections.sort(likedReplyIds);
+               fingerprint.append("LikedReplies(");
+               for (String likedReplyId : likedReplyIds) {
+                       fingerprint.append("Reply(").append(likedReplyId).append(')');
+               }
+               fingerprint.append(')');
+
+               return fingerprint.toString();
        }
 
        //
@@ -598,7 +634,7 @@ public class Sone {
         */
        @Override
        public int hashCode() {
-               return identity.getId().hashCode();
+               return id.hashCode();
        }
 
        /**
@@ -609,7 +645,7 @@ public class Sone {
                if (!(object instanceof Sone)) {
                        return false;
                }
-               return ((Sone) object).identity.getId().equals(identity.getId());
+               return ((Sone) object).id.equals(id);
        }
 
        /**
@@ -617,7 +653,7 @@ public class Sone {
         */
        @Override
        public String toString() {
-               return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
+               return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri(" + String.valueOf(insertUri).length() + "),friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
        }
 
 }