/*
- * FreenetSone - StatusUpdate.java - Copyright © 2010 David Roden
+ * Sone - Post.java - Copyright © 2010–2013 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
package net.pterodactylus.sone.data;
+import java.util.Comparator;
+
+import com.google.common.base.Predicate;
+
/**
* A post is a short message that a user writes in his Sone to let other users
* know what is going on.
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public class Post {
+public interface Post {
+
+ /** Comparator for posts, sorts descending by time. */
+ public static final Comparator<Post> TIME_COMPARATOR = 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()));
+ }
+
+ };
+
+ /** Filter for posts with timestamps from the future. */
+ public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
- /** The time of the post (in milliseconds since Jan 1, 1970 UTC). */
- private final long time;
+ @Override
+ public boolean apply(Post post) {
+ return post.getTime() <= System.currentTimeMillis();
+ }
- /** The text of the post. */
- private final String text;
+ };
+
+ //
+ // ACCESSORS
+ //
+
+ /**
+ * Returns the ID of the post.
+ *
+ * @return The ID of the post
+ */
+ public String getId();
/**
- * Creates a new post.
+ * Returns the Sone this post belongs to.
*
- * @param time
- * The time of the post (in milliseconds since Jan 1, 1970 UTC)
- * @param text
- * The text of the post
+ * @return The Sone of this post
*/
- public Post(long time, String text) {
- this.time = time;
- this.text = text;
- }
+ public Sone getSone();
+
+ /**
+ * Returns the recipient of this post, if any.
+ *
+ * @return The recipient of this post, or {@code null}
+ */
+ public Sone getRecipient();
/**
* Returns the time of the post.
*
* @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
*/
- public long getTime() {
- return time;
- }
+ public long getTime();
/**
* Returns the text of the post.
*
* @return The text of the post
*/
- public String getText() {
- return text;
- }
+ public String getText();
+
+ /**
+ * Returns whether this post is known.
+ *
+ * @return {@code true} if this post is known, {@code false} otherwise
+ */
+ public boolean isKnown();
+
+ /**
+ * Sets whether this post is known.
+ *
+ * @param known
+ * {@code true} if this post is known, {@code false} otherwise
+ * @return This post
+ */
+ public Post setKnown(boolean known);
}