/*
- * FreenetSone - StatusUpdate.java - Copyright © 2010 David Roden
+ * Sone - Post.java - Copyright © 2010–2012 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.UUID;
+import java.util.Comparator;
+
+import net.pterodactylus.util.collection.filter.Filter;
/**
* A post is a short message that a user writes in his Sone to let other users
*
* @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()));
+ }
- /** The GUID of the post. */
- private final UUID id;
+ };
- /** The Sone this post belongs to. */
- private final Sone sone;
+ /** Filter for posts with timestamps from the future. */
+ public static final Filter<Post> FUTURE_POSTS_FILTER = new Filter<Post>() {
- /** The time of the post (in milliseconds since Jan 1, 1970 UTC). */
- private final long time;
+ @Override
+ public boolean filterObject(Post post) {
+ return post.getTime() <= System.currentTimeMillis();
+ }
- /** The text of the post. */
- private final String text;
+ };
+
+ //
+ // ACCESSORS
+ //
/**
- * Creates a new post.
+ * Returns the ID of the post.
*
- * @param sone
- * The Sone this post belongs to
- * @param text
- * The text of the post
+ * @return The ID of the post
*/
- public Post(Sone sone, String text) {
- this(sone, System.currentTimeMillis(), text);
- }
+ public String getId();
/**
- * Creates a new post.
+ * Returns the Sone this post belongs to.
*
- * @param sone
- * 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(Sone sone, long time, String text) {
- this(UUID.randomUUID(), sone, time, text);
- }
+ public Sone getSone();
/**
- * Creates a new post.
+ * Sets the Sone of this post.
*
- * @param id
- * The ID of the post
* @param sone
- * 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
+ * The Sone of this post
+ * @return This post (for method chaining)
*/
- public Post(UUID id, Sone sone, long time, String text) {
- this.id = id;
- this.sone = sone;
- this.time = time;
- this.text = text;
- }
-
- //
- // ACCESSORS
- //
+ public Post setSone(Sone sone);
/**
- * Returns the ID of the post.
+ * Returns the recipient of this post, if any.
*
- * @return The ID of the post
+ * @return The recipient of this post, or {@code null}
*/
- public String getId() {
- return id.toString();
- }
+ public Sone getRecipient();
/**
- * Returns the Sone this post belongs to.
+ * Sets the recipient of this post.
*
- * @return The Sone of this post
+ * @param recipient
+ * The recipient of this post, or {@code null}
+ * @return This post (for method chaining)
*/
- public Sone getSone() {
- return sone;
- }
+ public Post setRecipient(Sone recipient);
/**
* 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();
+
+ /**
+ * Sets the time of this post.
+ *
+ * @param time
+ * The time of this post (in milliseconds since Jan 1, 1970 UTC)
+ * @return This post (for method chaining)
+ */
+ public Post setTime(long time);
/**
* Returns the text of the post.
*
* @return The text of the post
*/
- public String getText() {
- return text;
- }
+ public String getText();
- //
- // OBJECT METHODS
- //
+ /**
+ * Sets the text of this post.
+ *
+ * @param text
+ * The text of this post
+ * @return This post (for method chaining)
+ */
+ public Post setText(String text);
/**
- * {@inheritDoc}
+ * Returns whether this post is known.
+ *
+ * @return {@code true} if this post is known, {@code false} otherwise
*/
- @Override
- public int hashCode() {
- return text.hashCode() ^ (int) (time >> 32) ^ (int) (time & 0xffffffff);
- }
+ public boolean isKnown();
/**
- * {@inheritDoc}
+ * Sets whether this post is known.
+ *
+ * @param known
+ * {@code true} if this post is known, {@code false} otherwise
+ * @return This post
*/
- @Override
- public boolean equals(Object object) {
- if (!(object instanceof Post)) {
- return false;
- }
- return ((Post) object).id.equals(id);
- }
+ public Post setKnown(boolean known);
}
projects / Sone.git / blobdiff