Suppress some warnings about variables hiding other variables.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Sone.java
index 6467c20..fa3d78f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * FreenetSone - Sone.java - Copyright © 2010 David Roden
+ * Sone - Sone.java - Copyright © 2010 David Roden
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -27,8 +27,12 @@ import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import net.pterodactylus.sone.core.Core;
+import net.pterodactylus.sone.core.Options;
 import net.pterodactylus.sone.freenet.wot.Identity;
+import net.pterodactylus.sone.freenet.wot.OwnIdentity;
 import net.pterodactylus.sone.template.SoneAccessor;
+import net.pterodactylus.util.filter.Filter;
 import net.pterodactylus.util.logging.Logging;
 import freenet.keys.FreenetURI;
 
@@ -40,7 +44,7 @@ import freenet.keys.FreenetURI;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Sone {
+public class Sone implements Fingerprintable, Comparable<Sone> {
 
        /** comparator that sorts Sones by their nice name. */
        public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
@@ -56,6 +60,48 @@ public class Sone {
 
        };
 
+       /**
+        * Comparator that sorts Sones by last activity (least recent active first).
+        */
+       public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
+
+               @Override
+               public int compare(Sone firstSone, Sone secondSone) {
+                       return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
+               }
+       };
+
+       /** Comparator that sorts Sones by numbers of posts (descending). */
+       public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public int compare(Sone leftSone, Sone rightSone) {
+                       return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
+               }
+       };
+
+       /** Filter to remove Sones that have not been downloaded. */
+       public static final Filter<Sone> EMPTY_SONE_FILTER = new Filter<Sone>() {
+
+               @Override
+               public boolean filterObject(Sone sone) {
+                       return sone.getTime() != 0;
+               }
+       };
+
+       /** Filter that matches all {@link Core#isLocalSone(Sone) local Sones}. */
+       public static final Filter<Sone> LOCAL_SONE_FILTER = new Filter<Sone>() {
+
+               @Override
+               public boolean filterObject(Sone sone) {
+                       return sone.getIdentity() instanceof OwnIdentity;
+               }
+
+       };
+
        /** The logger. */
        private static final Logger logger = Logging.getLogger(Sone.class);
 
@@ -79,10 +125,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>());
@@ -96,8 +145,8 @@ 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;
+       /** Sone-specific options. */
+       private final Options options = new Options();
 
        /**
         * Creates a new Sone.
@@ -164,7 +213,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;
        }
 
        /**
@@ -176,7 +225,7 @@ public class Sone {
         */
        public Sone setRequestUri(FreenetURI requestUri) {
                if (this.requestUri == null) {
-                       this.requestUri = requestUri.setDocName("Sone").setMetaString(new String[0]);
+                       this.requestUri = requestUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]);
                        return this;
                }
                if (!this.requestUri.equalsKeypair(requestUri)) {
@@ -204,7 +253,7 @@ public class Sone {
         */
        public Sone setInsertUri(FreenetURI insertUri) {
                if (this.insertUri == null) {
-                       this.insertUri = insertUri.setDocName("Sone").setMetaString(new String[0]);
+                       this.insertUri = insertUri.setKeyType("USK").setDocName("Sone").setMetaString(new String[0]);
                        return this;
                }
                if (!this.insertUri.equalsKeypair(insertUri)) {
@@ -267,7 +316,7 @@ public class Sone {
         *
         * @return A copy of the profile
         */
-       public Profile getProfile() {
+       public synchronized Profile getProfile() {
                return new Profile(profile);
        }
 
@@ -281,7 +330,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;
        }
 
        /**
@@ -289,9 +358,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, NICE_NAME_COMPARATOR);
+       public List<String> getFriends() {
+               List<String> friends = new ArrayList<String>(friendSones);
                return friends;
        }
 
@@ -302,7 +370,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;
@@ -311,13 +379,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);
        }
 
        /**
@@ -327,8 +395,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;
@@ -337,12 +405,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;
        }
 
@@ -368,9 +436,10 @@ public class Sone {
         * @return This Sone (for method chaining)
         */
        public synchronized Sone setPosts(Collection<Post> posts) {
-               this.posts.clear();
-               this.posts.addAll(posts);
-               modificationCounter++;
+               synchronized (this) {
+                       this.posts.clear();
+                       this.posts.addAll(posts);
+               }
                return this;
        }
 
@@ -384,7 +453,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++;
                }
        }
 
@@ -395,8 +463,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);
                }
        }
 
@@ -419,7 +487,6 @@ public class Sone {
        public synchronized Sone setReplies(Collection<Reply> replies) {
                this.replies.clear();
                this.replies.addAll(replies);
-               modificationCounter++;
                return this;
        }
 
@@ -431,8 +498,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);
                }
        }
 
@@ -443,8 +510,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);
                }
        }
 
@@ -467,7 +534,6 @@ public class Sone {
        public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
                this.likedPostIds.clear();
                this.likedPostIds.addAll(likedPostIds);
-               modificationCounter++;
                return this;
        }
 
@@ -491,9 +557,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;
        }
 
@@ -505,9 +569,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;
        }
 
@@ -530,7 +592,6 @@ public class Sone {
        public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
                this.likedReplyIds.clear();
                this.likedReplyIds.addAll(likedReplyIds);
-               modificationCounter++;
                return this;
        }
 
@@ -554,9 +615,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;
        }
 
@@ -568,29 +627,77 @@ 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.
+        * Returns Sone-specific options.
         *
-        * @return The modification counter
+        * @return The options of this Sone
         */
-       public synchronized long getModificationCounter() {
-               return modificationCounter;
+       public Options getOptions() {
+               return options;
        }
 
+       //
+       // 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(")");
+
+               @SuppressWarnings("hiding")
+               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(')');
+
+               @SuppressWarnings("hiding")
+               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(')');
+
+               @SuppressWarnings("hiding")
+               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();
+       }
+
+       //
+       // INTERFACE Comparable<Sone>
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public int compareTo(Sone sone) {
+               return NICE_NAME_COMPARATOR.compare(this, sone);
        }
 
        //